Summary
Request & Response
Diagnostics
Care Provision
Medications
Workflow
Entities
Management
Individuals
General
Billing
Support
Payment
Security
Other
Conformance
Terminology
Documents
Definitional Artifacts
Medication Definition
Evidence-Based Medicine
Quality Reporting & Testing
Public Health & Research
Complex
Primitive
ActivityDefinition
CanonicalResource
CapabilityStatement
ChargeItemDefinition
Claim
CodeSystem
Composition
ConceptMap
CoverageEligibilityRequest
DocumentReference
Encounter
EpisodeOfCare
Group
Library
List
Measure
MedicinalProductDefinition
MessageHeader
NamingSystem
Observation
Patient
PlanDefinition
Resource
SpecimenDefinition
StructureDefinition
StructureMap
Subscription
ValueSet
default
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.
ExplanationOfBenefit
Path
ExplanationOfBenefit
Id
ExplanationOfBenefit
Cardinality
0 - *
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.
Comment
Constraint
dom-2 [error]
If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3 [error]
If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4 [error]
If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5 [error]
If a resource is contained in another resource, it SHALL NOT have a security label
dom-6 [warning]
A resource should have narrative for robust management
Path
ExplanationOfBenefit.identifier
Id
ExplanationOfBenefit.identifier
Type
Cardinality
0 - *
Definition
A unique identifier assigned to this explanation of benefit.
Comment
Requirements
Allows EOBs to be distinguished and referenced.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.identifier.Identifier.use
Id
Identifier.use
Type
Cardinality
0 - 1
Definition
The purpose of this identifier.
Comment
Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Requirements
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Binding
Strength
required
Description
Identifies the purpose for this identifier, if known .
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.identifier.Identifier.type
Id
Identifier.type
Type
Cardinality
0 - 1
Definition
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Comment
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.
Requirements
Allows users to make use of identifiers when the identifier system is not known.
Binding
Strength
extensible
Description
A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.identifier.Identifier.type.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.identifier.Identifier.type.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
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 be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.identifier.Identifier.type.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.identifier.Identifier.type.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
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).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.identifier.Identifier.type.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.identifier.Identifier.type.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
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.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.identifier.Identifier.system
Id
Identifier.system
Type
Cardinality
0 - 1
Definition
Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.
Comment
Identifier.system is always case sensitive.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.identifier.Identifier.value
Id
Identifier.value
Type
Cardinality
0 - 1
Definition
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comment
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 [http://hl7.org/fhir/StructureDefinition/rendered-value](http://hl7.org/fhir/extensions/StructureDefinition-rendered-value.html)). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ident-1
Path
ExplanationOfBenefit.identifier.Identifier.period
Id
Identifier.period
Type
Cardinality
0 - 1
Definition
Time period during which identifier is/was valid for use.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.identifier.Identifier.period.Period.start
Id
Period.start
Type
Cardinality
0 - 1
Definition
The start of the period. The boundary is inclusive.
Comment
If the low element is missing, the meaning is that the low boundary is not known.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
ExplanationOfBenefit.identifier.Identifier.period.Period.end
Id
Period.end
Type
Cardinality
0 - 1
Definition
The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. 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.
Comment
The end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
ExplanationOfBenefit.identifier.Identifier.assigner
Id
Identifier.assigner
Type
Cardinality
0 - 1
Definition
Organization that issued/manages the identifier.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.identifier.Identifier.assigner.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
ref-1
Path
ExplanationOfBenefit.identifier.Identifier.assigner.Reference.type
Id
Reference.type
Type
Cardinality
0 - 1
Definition
The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comment
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.
Binding
Strength
extensible
Description
Aa resource (or, for logical models, the URI of the logical model).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.identifier.Identifier.assigner.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.
Comment
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.
Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.identifier.Identifier.assigner.Reference.identifier.Identifier.use
Id
Identifier.use
Type
Cardinality
0 - 1
Definition
The purpose of this identifier.
Comment
Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Requirements
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Binding
Strength
required
Description
Identifies the purpose for this identifier, if known .
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.identifier.Identifier.assigner.Reference.identifier.Identifier.type
Id
Identifier.type
Type
Cardinality
0 - 1
Definition
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Comment
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.
Requirements
Allows users to make use of identifiers when the identifier system is not known.
Binding
Strength
extensible
Description
A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.identifier.Identifier.assigner.Reference.identifier.Identifier.system
Id
Identifier.system
Type
Cardinality
0 - 1
Definition
Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.
Comment
Identifier.system is always case sensitive.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.identifier.Identifier.assigner.Reference.identifier.Identifier.value
Id
Identifier.value
Type
Cardinality
0 - 1
Definition
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comment
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 [http://hl7.org/fhir/StructureDefinition/rendered-value](http://hl7.org/fhir/extensions/StructureDefinition-rendered-value.html)). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ident-1
Path
ExplanationOfBenefit.identifier.Identifier.assigner.Reference.identifier.Identifier.period
Id
Identifier.period
Type
Cardinality
0 - 1
Definition
Time period during which identifier is/was valid for use.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.identifier.Identifier.assigner.Reference.identifier.Identifier.assigner
Id
Identifier.assigner
Type
Cardinality
0 - 1
Definition
Organization that issued/manages the identifier.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.identifier.Identifier.assigner.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.traceNumber
Id
ExplanationOfBenefit.traceNumber
Type
Cardinality
0 - *
Definition
Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.
Comment
Requirements
Allows partners to uniquely identify components for tracking.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.traceNumber.Identifier.use
Id
Identifier.use
Type
Cardinality
0 - 1
Definition
The purpose of this identifier.
Comment
Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Requirements
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Binding
Strength
required
Description
Identifies the purpose for this identifier, if known .
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.traceNumber.Identifier.type
Id
Identifier.type
Type
Cardinality
0 - 1
Definition
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Comment
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.
Requirements
Allows users to make use of identifiers when the identifier system is not known.
Binding
Strength
extensible
Description
A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.traceNumber.Identifier.type.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.traceNumber.Identifier.type.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
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 be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.traceNumber.Identifier.type.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.traceNumber.Identifier.type.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
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).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.traceNumber.Identifier.type.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.traceNumber.Identifier.type.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
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.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.traceNumber.Identifier.system
Id
Identifier.system
Type
Cardinality
0 - 1
Definition
Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.
Comment
Identifier.system is always case sensitive.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.traceNumber.Identifier.value
Id
Identifier.value
Type
Cardinality
0 - 1
Definition
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comment
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 [http://hl7.org/fhir/StructureDefinition/rendered-value](http://hl7.org/fhir/extensions/StructureDefinition-rendered-value.html)). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ident-1
Path
ExplanationOfBenefit.traceNumber.Identifier.period
Id
Identifier.period
Type
Cardinality
0 - 1
Definition
Time period during which identifier is/was valid for use.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.traceNumber.Identifier.period.Period.start
Id
Period.start
Type
Cardinality
0 - 1
Definition
The start of the period. The boundary is inclusive.
Comment
If the low element is missing, the meaning is that the low boundary is not known.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
ExplanationOfBenefit.traceNumber.Identifier.period.Period.end
Id
Period.end
Type
Cardinality
0 - 1
Definition
The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. 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.
Comment
The end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
ExplanationOfBenefit.traceNumber.Identifier.assigner
Id
Identifier.assigner
Type
Cardinality
0 - 1
Definition
Organization that issued/manages the identifier.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.traceNumber.Identifier.assigner.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
ref-1
Path
ExplanationOfBenefit.traceNumber.Identifier.assigner.Reference.type
Id
Reference.type
Type
Cardinality
0 - 1
Definition
The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comment
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.
Binding
Strength
extensible
Description
Aa resource (or, for logical models, the URI of the logical model).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.traceNumber.Identifier.assigner.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.
Comment
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.
Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.traceNumber.Identifier.assigner.Reference.identifier.Identifier.use
Id
Identifier.use
Type
Cardinality
0 - 1
Definition
The purpose of this identifier.
Comment
Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Requirements
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Binding
Strength
required
Description
Identifies the purpose for this identifier, if known .
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.traceNumber.Identifier.assigner.Reference.identifier.Identifier.type
Id
Identifier.type
Type
Cardinality
0 - 1
Definition
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Comment
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.
Requirements
Allows users to make use of identifiers when the identifier system is not known.
Binding
Strength
extensible
Description
A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.traceNumber.Identifier.assigner.Reference.identifier.Identifier.system
Id
Identifier.system
Type
Cardinality
0 - 1
Definition
Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.
Comment
Identifier.system is always case sensitive.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.traceNumber.Identifier.assigner.Reference.identifier.Identifier.value
Id
Identifier.value
Type
Cardinality
0 - 1
Definition
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comment
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 [http://hl7.org/fhir/StructureDefinition/rendered-value](http://hl7.org/fhir/extensions/StructureDefinition-rendered-value.html)). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ident-1
Path
ExplanationOfBenefit.traceNumber.Identifier.assigner.Reference.identifier.Identifier.period
Id
Identifier.period
Type
Cardinality
0 - 1
Definition
Time period during which identifier is/was valid for use.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.traceNumber.Identifier.assigner.Reference.identifier.Identifier.assigner
Id
Identifier.assigner
Type
Cardinality
0 - 1
Definition
Organization that issued/manages the identifier.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.traceNumber.Identifier.assigner.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.status
Id
ExplanationOfBenefit.status
Type
Cardinality
1 - 1
Definition
The status of the resource instance.
Comment
This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.
Requirements
Need to track the status of the resource as 'draft' resources may undergo further edits while 'active' resources are immutable and may only have their status changed to 'cancelled'.
Binding
Strength
required
Description
A code specifying the state of the resource instance.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.type
Id
ExplanationOfBenefit.type
Type
Cardinality
1 - 1
Definition
The category of claim, e.g. oral, pharmacy, vision, institutional, professional.
Comment
The majority of jurisdictions use: oral, pharmacy, vision, professional and institutional, or variants on those terms, as the general styles of claims. The valueset is extensible to accommodate other jurisdictional requirements.
Requirements
Claim type determine the general sets of business rules applied for information requirements and adjudication.
Binding
Strength
extensible
Description
The type or discipline-style of the claim.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.type.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.type.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
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 be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.type.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.type.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
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).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.type.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.type.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
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.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.subType
Id
ExplanationOfBenefit.subType
Type
Cardinality
0 - 1
Definition
A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.
Comment
This may contain the local bill type codes such as the US UB-04 bill type code.
Requirements
Some jurisdictions need a finer grained claim type for routing and adjudication.
Binding
Strength
example
Description
A more granular claim typecode.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.subType.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.subType.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
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 be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.subType.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.subType.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
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).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.subType.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.subType.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
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.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.use
Id
ExplanationOfBenefit.use
Type
Cardinality
1 - 1
Definition
A code to indicate whether the nature of the request is: Claim - A request to an Insurer to adjudicate the supplied charges for health care goods and services under the identified policy and to pay the determined Benefit amount, if any; Preauthorization - A request to an Insurer to adjudicate the supplied proposed future charges for health care goods and services under the identified policy and to approve the services and provide the expected benefit amounts and potentially to reserve funds to pay the benefits when Claims for the indicated services are later submitted; or, Pre-determination - A request to an Insurer to adjudicate the supplied 'what if' charges for health care goods and services under the identified policy and report back what the Benefit payable would be had the services actually been provided.
Comment
Requirements
This element is required to understand the nature of the request for adjudication.
Binding
Strength
required
Description
Complete, proposed, exploratory, other.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.patient
Id
ExplanationOfBenefit.patient
Type
Cardinality
1 - 1
Definition
The party to whom the professional services and/or products have been supplied or are being considered and for whom actual for forecast reimbursement is sought.
Comment
Requirements
The patient must be supplied to the insurer so that confirmation of coverage and service history may be considered as part of the authorization and/or adjudiction.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.patient.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
ref-1
Path
ExplanationOfBenefit.patient.Reference.type
Id
Reference.type
Type
Cardinality
0 - 1
Definition
The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comment
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.
Binding
Strength
extensible
Description
Aa resource (or, for logical models, the URI of the logical model).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.patient.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.
Comment
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.
Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.patient.Reference.identifier.Identifier.use
Id
Identifier.use
Type
Cardinality
0 - 1
Definition
The purpose of this identifier.
Comment
Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Requirements
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Binding
Strength
required
Description
Identifies the purpose for this identifier, if known .
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.patient.Reference.identifier.Identifier.type
Id
Identifier.type
Type
Cardinality
0 - 1
Definition
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Comment
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.
Requirements
Allows users to make use of identifiers when the identifier system is not known.
Binding
Strength
extensible
Description
A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.patient.Reference.identifier.Identifier.type.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.patient.Reference.identifier.Identifier.system
Id
Identifier.system
Type
Cardinality
0 - 1
Definition
Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.
Comment
Identifier.system is always case sensitive.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.patient.Reference.identifier.Identifier.value
Id
Identifier.value
Type
Cardinality
0 - 1
Definition
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comment
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 [http://hl7.org/fhir/StructureDefinition/rendered-value](http://hl7.org/fhir/extensions/StructureDefinition-rendered-value.html)). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ident-1
Path
ExplanationOfBenefit.patient.Reference.identifier.Identifier.period
Id
Identifier.period
Type
Cardinality
0 - 1
Definition
Time period during which identifier is/was valid for use.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.patient.Reference.identifier.Identifier.period.Period.start
Id
Period.start
Type
Cardinality
0 - 1
Definition
The start of the period. The boundary is inclusive.
Comment
If the low element is missing, the meaning is that the low boundary is not known.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
ExplanationOfBenefit.patient.Reference.identifier.Identifier.period.Period.end
Id
Period.end
Type
Cardinality
0 - 1
Definition
The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. 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.
Comment
The end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
ExplanationOfBenefit.patient.Reference.identifier.Identifier.assigner
Id
Identifier.assigner
Type
Cardinality
0 - 1
Definition
Organization that issued/manages the identifier.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.patient.Reference.identifier.Identifier.assigner.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
ref-1
Path
ExplanationOfBenefit.patient.Reference.identifier.Identifier.assigner.Reference.type
Id
Reference.type
Type
Cardinality
0 - 1
Definition
The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comment
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.
Binding
Strength
extensible
Description
Aa resource (or, for logical models, the URI of the logical model).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.patient.Reference.identifier.Identifier.assigner.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.
Comment
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.
Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.patient.Reference.identifier.Identifier.assigner.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.patient.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.billablePeriod
Id
ExplanationOfBenefit.billablePeriod
Type
Cardinality
0 - 1
Definition
The period for which charges are being submitted.
Comment
Typically this would be today or in the past for a claim, and today or in the future for preauthorizations and prodeterminations. Typically line item dates of service should fall within the billing period if one is specified.
Requirements
A number jurisdictions required the submission of the billing period when submitting claims for example for hospital stays or long-term care.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.billablePeriod.Period.start
Id
Period.start
Type
Cardinality
0 - 1
Definition
The start of the period. The boundary is inclusive.
Comment
If the low element is missing, the meaning is that the low boundary is not known.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
ExplanationOfBenefit.billablePeriod.Period.end
Id
Period.end
Type
Cardinality
0 - 1
Definition
The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. 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.
Comment
The end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
ExplanationOfBenefit.created
Id
ExplanationOfBenefit.created
Type
Cardinality
1 - 1
Definition
The date this resource was created.
Comment
Requirements
Need to record a timestamp for use by both the recipient and the issuer.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.enterer
Id
ExplanationOfBenefit.enterer
Type
Cardinality
0 - 1
Definition
Individual who created the claim, predetermination or preauthorization.
Comment
Requirements
Some jurisdictions require the contact information for personnel completing claims.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.enterer.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
ref-1
Path
ExplanationOfBenefit.enterer.Reference.type
Id
Reference.type
Type
Cardinality
0 - 1
Definition
The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comment
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.
Binding
Strength
extensible
Description
Aa resource (or, for logical models, the URI of the logical model).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.enterer.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.
Comment
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.
Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.enterer.Reference.identifier.Identifier.use
Id
Identifier.use
Type
Cardinality
0 - 1
Definition
The purpose of this identifier.
Comment
Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Requirements
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Binding
Strength
required
Description
Identifies the purpose for this identifier, if known .
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.enterer.Reference.identifier.Identifier.type
Id
Identifier.type
Type
Cardinality
0 - 1
Definition
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Comment
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.
Requirements
Allows users to make use of identifiers when the identifier system is not known.
Binding
Strength
extensible
Description
A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.enterer.Reference.identifier.Identifier.type.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.enterer.Reference.identifier.Identifier.system
Id
Identifier.system
Type
Cardinality
0 - 1
Definition
Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.
Comment
Identifier.system is always case sensitive.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.enterer.Reference.identifier.Identifier.value
Id
Identifier.value
Type
Cardinality
0 - 1
Definition
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comment
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 [http://hl7.org/fhir/StructureDefinition/rendered-value](http://hl7.org/fhir/extensions/StructureDefinition-rendered-value.html)). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ident-1
Path
ExplanationOfBenefit.enterer.Reference.identifier.Identifier.period
Id
Identifier.period
Type
Cardinality
0 - 1
Definition
Time period during which identifier is/was valid for use.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.enterer.Reference.identifier.Identifier.period.Period.start
Id
Period.start
Type
Cardinality
0 - 1
Definition
The start of the period. The boundary is inclusive.
Comment
If the low element is missing, the meaning is that the low boundary is not known.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
ExplanationOfBenefit.enterer.Reference.identifier.Identifier.period.Period.end
Id
Period.end
Type
Cardinality
0 - 1
Definition
The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. 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.
Comment
The end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
ExplanationOfBenefit.enterer.Reference.identifier.Identifier.assigner
Id
Identifier.assigner
Type
Cardinality
0 - 1
Definition
Organization that issued/manages the identifier.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.enterer.Reference.identifier.Identifier.assigner.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
ref-1
Path
ExplanationOfBenefit.enterer.Reference.identifier.Identifier.assigner.Reference.type
Id
Reference.type
Type
Cardinality
0 - 1
Definition
The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comment
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.
Binding
Strength
extensible
Description
Aa resource (or, for logical models, the URI of the logical model).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.enterer.Reference.identifier.Identifier.assigner.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.
Comment
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.
Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.enterer.Reference.identifier.Identifier.assigner.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.enterer.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.insurer
Id
ExplanationOfBenefit.insurer
Type
Cardinality
0 - 1
Definition
The party responsible for authorization, adjudication and reimbursement.
Comment
Requirements
To be a valid claim, preauthorization or predetermination there must be a party who is responsible for adjudicating the contents against a policy which provides benefits for the patient.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.insurer.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
ref-1
Path
ExplanationOfBenefit.insurer.Reference.type
Id
Reference.type
Type
Cardinality
0 - 1
Definition
The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comment
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.
Binding
Strength
extensible
Description
Aa resource (or, for logical models, the URI of the logical model).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.insurer.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.
Comment
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.
Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.insurer.Reference.identifier.Identifier.use
Id
Identifier.use
Type
Cardinality
0 - 1
Definition
The purpose of this identifier.
Comment
Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Requirements
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Binding
Strength
required
Description
Identifies the purpose for this identifier, if known .
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.insurer.Reference.identifier.Identifier.type
Id
Identifier.type
Type
Cardinality
0 - 1
Definition
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Comment
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.
Requirements
Allows users to make use of identifiers when the identifier system is not known.
Binding
Strength
extensible
Description
A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.insurer.Reference.identifier.Identifier.type.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.insurer.Reference.identifier.Identifier.system
Id
Identifier.system
Type
Cardinality
0 - 1
Definition
Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.
Comment
Identifier.system is always case sensitive.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.insurer.Reference.identifier.Identifier.value
Id
Identifier.value
Type
Cardinality
0 - 1
Definition
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comment
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 [http://hl7.org/fhir/StructureDefinition/rendered-value](http://hl7.org/fhir/extensions/StructureDefinition-rendered-value.html)). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ident-1
Path
ExplanationOfBenefit.insurer.Reference.identifier.Identifier.period
Id
Identifier.period
Type
Cardinality
0 - 1
Definition
Time period during which identifier is/was valid for use.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.insurer.Reference.identifier.Identifier.period.Period.start
Id
Period.start
Type
Cardinality
0 - 1
Definition
The start of the period. The boundary is inclusive.
Comment
If the low element is missing, the meaning is that the low boundary is not known.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
ExplanationOfBenefit.insurer.Reference.identifier.Identifier.period.Period.end
Id
Period.end
Type
Cardinality
0 - 1
Definition
The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. 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.
Comment
The end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
ExplanationOfBenefit.insurer.Reference.identifier.Identifier.assigner
Id
Identifier.assigner
Type
Cardinality
0 - 1
Definition
Organization that issued/manages the identifier.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.insurer.Reference.identifier.Identifier.assigner.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
ref-1
Path
ExplanationOfBenefit.insurer.Reference.identifier.Identifier.assigner.Reference.type
Id
Reference.type
Type
Cardinality
0 - 1
Definition
The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comment
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.
Binding
Strength
extensible
Description
Aa resource (or, for logical models, the URI of the logical model).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.insurer.Reference.identifier.Identifier.assigner.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.
Comment
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.
Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.insurer.Reference.identifier.Identifier.assigner.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.insurer.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.provider
Id
ExplanationOfBenefit.provider
Type
Cardinality
0 - 1
Definition
The provider which is responsible for the claim, predetermination or preauthorization.
Comment
Typically this field would be 1..1 where this party is accountable for the data content within the claim but is not necessarily the facility, provider group or practitioner who provided the products and services listed within this claim resource. This field is the Billing Provider, for example, a facility, provider group, lab or practitioner.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.provider.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
ref-1
Path
ExplanationOfBenefit.provider.Reference.type
Id
Reference.type
Type
Cardinality
0 - 1
Definition
The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comment
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.
Binding
Strength
extensible
Description
Aa resource (or, for logical models, the URI of the logical model).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.provider.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.
Comment
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.
Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.provider.Reference.identifier.Identifier.use
Id
Identifier.use
Type
Cardinality
0 - 1
Definition
The purpose of this identifier.
Comment
Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Requirements
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Binding
Strength
required
Description
Identifies the purpose for this identifier, if known .
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.provider.Reference.identifier.Identifier.type
Id
Identifier.type
Type
Cardinality
0 - 1
Definition
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Comment
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.
Requirements
Allows users to make use of identifiers when the identifier system is not known.
Binding
Strength
extensible
Description
A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.provider.Reference.identifier.Identifier.type.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.provider.Reference.identifier.Identifier.system
Id
Identifier.system
Type
Cardinality
0 - 1
Definition
Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.
Comment
Identifier.system is always case sensitive.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.provider.Reference.identifier.Identifier.value
Id
Identifier.value
Type
Cardinality
0 - 1
Definition
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comment
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 [http://hl7.org/fhir/StructureDefinition/rendered-value](http://hl7.org/fhir/extensions/StructureDefinition-rendered-value.html)). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ident-1
Path
ExplanationOfBenefit.provider.Reference.identifier.Identifier.period
Id
Identifier.period
Type
Cardinality
0 - 1
Definition
Time period during which identifier is/was valid for use.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.provider.Reference.identifier.Identifier.period.Period.start
Id
Period.start
Type
Cardinality
0 - 1
Definition
The start of the period. The boundary is inclusive.
Comment
If the low element is missing, the meaning is that the low boundary is not known.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
ExplanationOfBenefit.provider.Reference.identifier.Identifier.period.Period.end
Id
Period.end
Type
Cardinality
0 - 1
Definition
The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. 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.
Comment
The end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
ExplanationOfBenefit.provider.Reference.identifier.Identifier.assigner
Id
Identifier.assigner
Type
Cardinality
0 - 1
Definition
Organization that issued/manages the identifier.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.provider.Reference.identifier.Identifier.assigner.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
ref-1
Path
ExplanationOfBenefit.provider.Reference.identifier.Identifier.assigner.Reference.type
Id
Reference.type
Type
Cardinality
0 - 1
Definition
The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comment
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.
Binding
Strength
extensible
Description
Aa resource (or, for logical models, the URI of the logical model).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.provider.Reference.identifier.Identifier.assigner.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.
Comment
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.
Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.provider.Reference.identifier.Identifier.assigner.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.provider.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.priority
Id
ExplanationOfBenefit.priority
Type
Cardinality
0 - 1
Definition
The provider-required urgency of processing the request. Typical values include: stat, normal deferred.
Comment
If a claim processor is unable to complete the processing as per the priority then they should generate an error and not process the request.
Requirements
The provider may need to indicate their processing requirements so that the processor can indicate if they are unable to comply.
Binding
Strength
example
Description
The timeliness with which processing is required: stat, normal, deferred.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.priority.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.priority.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
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 be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.priority.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.priority.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
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).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.priority.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.priority.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
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.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.fundsReserveRequested
Id
ExplanationOfBenefit.fundsReserveRequested
Type
Cardinality
0 - 1
Definition
A code to indicate whether and for whom funds are to be reserved for future claims.
Comment
This field is only used for preauthorizations.
Requirements
In the case of a Pre-Determination/Pre-Authorization the provider may request that funds in the amount of the expected Benefit be reserved ('Patient' or 'Provider') to pay for the Benefits determined on the subsequent claim(s). 'None' explicitly indicates no funds reserving is requested.
Binding
Strength
example
Description
For whom funds are to be reserved: (Patient, Provider, None).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.fundsReserveRequested.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.fundsReserveRequested.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
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 be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.fundsReserveRequested.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.fundsReserveRequested.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
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).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.fundsReserveRequested.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.fundsReserveRequested.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
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.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.fundsReserve
Id
ExplanationOfBenefit.fundsReserve
Type
Cardinality
0 - 1
Definition
A code, used only on a response to a preauthorization, to indicate whether the benefits payable have been reserved and for whom.
Comment
Fund would be release by a future claim quoting the preAuthRef of this response. Examples of values include: provider, patient, none.
Requirements
Needed to advise the submitting provider on whether the rquest for reservation of funds has been honored.
Binding
Strength
example
Description
For whom funds are to be reserved: (Patient, Provider, None).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.fundsReserve.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.fundsReserve.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
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 be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.fundsReserve.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.fundsReserve.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
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).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.fundsReserve.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.fundsReserve.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
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.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.related
Id
ExplanationOfBenefit.related
Type
Cardinality
0 - *
Definition
Other claims which are related to this claim such as prior submissions or claims for related services or for the same event.
Comment
For example, for the original treatment and follow-up exams.
Requirements
For workplace or other accidents it is common to relate separate claims arising from the same event.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.related.claim
Id
ExplanationOfBenefit.related.claim
Type
Cardinality
0 - 1
Definition
Reference to a related claim.
Comment
Requirements
For workplace or other accidents it is common to relate separate claims arising from the same event.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.related.claim.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
ref-1
Path
ExplanationOfBenefit.related.claim.Reference.type
Id
Reference.type
Type
Cardinality
0 - 1
Definition
The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comment
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.
Binding
Strength
extensible
Description
Aa resource (or, for logical models, the URI of the logical model).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.related.claim.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.
Comment
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.
Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.related.claim.Reference.identifier.Identifier.use
Id
Identifier.use
Type
Cardinality
0 - 1
Definition
The purpose of this identifier.
Comment
Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Requirements
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Binding
Strength
required
Description
Identifies the purpose for this identifier, if known .
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.related.claim.Reference.identifier.Identifier.type
Id
Identifier.type
Type
Cardinality
0 - 1
Definition
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Comment
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.
Requirements
Allows users to make use of identifiers when the identifier system is not known.
Binding
Strength
extensible
Description
A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.related.claim.Reference.identifier.Identifier.system
Id
Identifier.system
Type
Cardinality
0 - 1
Definition
Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.
Comment
Identifier.system is always case sensitive.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.related.claim.Reference.identifier.Identifier.value
Id
Identifier.value
Type
Cardinality
0 - 1
Definition
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comment
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 [http://hl7.org/fhir/StructureDefinition/rendered-value](http://hl7.org/fhir/extensions/StructureDefinition-rendered-value.html)). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ident-1
Path
ExplanationOfBenefit.related.claim.Reference.identifier.Identifier.period
Id
Identifier.period
Type
Cardinality
0 - 1
Definition
Time period during which identifier is/was valid for use.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.related.claim.Reference.identifier.Identifier.assigner
Id
Identifier.assigner
Type
Cardinality
0 - 1
Definition
Organization that issued/manages the identifier.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.related.claim.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.related.relationship
Id
ExplanationOfBenefit.related.relationship
Type
Cardinality
0 - 1
Definition
A code to convey how the claims are related.
Comment
For example, prior claim or umbrella.
Requirements
Some insurers need a declaration of the type of relationship.
Binding
Strength
example
Description
Relationship of this claim to a related Claim.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.related.relationship.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.related.relationship.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
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 be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.related.relationship.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.related.relationship.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
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).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.related.relationship.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.related.relationship.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
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.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.related.reference
Id
ExplanationOfBenefit.related.reference
Type
Cardinality
0 - 1
Definition
An alternate organizational reference to the case or file to which this particular claim pertains.
Comment
For example, Property/Casualty insurer claim number or Workers Compensation case number.
Requirements
In cases where an event-triggered claim is being submitted to an insurer which requires a reference number to be specified on all exchanges.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.related.reference.Identifier.use
Id
Identifier.use
Type
Cardinality
0 - 1
Definition
The purpose of this identifier.
Comment
Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Requirements
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Binding
Strength
required
Description
Identifies the purpose for this identifier, if known .
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.related.reference.Identifier.type
Id
Identifier.type
Type
Cardinality
0 - 1
Definition
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Comment
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.
Requirements
Allows users to make use of identifiers when the identifier system is not known.
Binding
Strength
extensible
Description
A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.related.reference.Identifier.type.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.related.reference.Identifier.system
Id
Identifier.system
Type
Cardinality
0 - 1
Definition
Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.
Comment
Identifier.system is always case sensitive.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.related.reference.Identifier.value
Id
Identifier.value
Type
Cardinality
0 - 1
Definition
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comment
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 [http://hl7.org/fhir/StructureDefinition/rendered-value](http://hl7.org/fhir/extensions/StructureDefinition-rendered-value.html)). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ident-1
Path
ExplanationOfBenefit.related.reference.Identifier.period
Id
Identifier.period
Type
Cardinality
0 - 1
Definition
Time period during which identifier is/was valid for use.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.related.reference.Identifier.period.Period.start
Id
Period.start
Type
Cardinality
0 - 1
Definition
The start of the period. The boundary is inclusive.
Comment
If the low element is missing, the meaning is that the low boundary is not known.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
ExplanationOfBenefit.related.reference.Identifier.period.Period.end
Id
Period.end
Type
Cardinality
0 - 1
Definition
The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. 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.
Comment
The end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
ExplanationOfBenefit.related.reference.Identifier.assigner
Id
Identifier.assigner
Type
Cardinality
0 - 1
Definition
Organization that issued/manages the identifier.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.related.reference.Identifier.assigner.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
ref-1
Path
ExplanationOfBenefit.related.reference.Identifier.assigner.Reference.type
Id
Reference.type
Type
Cardinality
0 - 1
Definition
The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comment
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.
Binding
Strength
extensible
Description
Aa resource (or, for logical models, the URI of the logical model).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.related.reference.Identifier.assigner.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.
Comment
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.
Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.related.reference.Identifier.assigner.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.prescription
Id
ExplanationOfBenefit.prescription
Type
Cardinality
0 - 1
Definition
Prescription is the document/authorization given to the claim author for them to provide products and services for which consideration (reimbursement) is sought. Could be a RX for medications, an 'order' for oxygen or wheelchair or physiotherapy treatments.
Comment
Requirements
Required to authorize the dispensing of controlled substances and devices.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.prescription.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
ref-1
Path
ExplanationOfBenefit.prescription.Reference.type
Id
Reference.type
Type
Cardinality
0 - 1
Definition
The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comment
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.
Binding
Strength
extensible
Description
Aa resource (or, for logical models, the URI of the logical model).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.prescription.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.
Comment
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.
Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.prescription.Reference.identifier.Identifier.use
Id
Identifier.use
Type
Cardinality
0 - 1
Definition
The purpose of this identifier.
Comment
Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Requirements
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Binding
Strength
required
Description
Identifies the purpose for this identifier, if known .
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.prescription.Reference.identifier.Identifier.type
Id
Identifier.type
Type
Cardinality
0 - 1
Definition
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Comment
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.
Requirements
Allows users to make use of identifiers when the identifier system is not known.
Binding
Strength
extensible
Description
A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.prescription.Reference.identifier.Identifier.type.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.prescription.Reference.identifier.Identifier.system
Id
Identifier.system
Type
Cardinality
0 - 1
Definition
Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.
Comment
Identifier.system is always case sensitive.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.prescription.Reference.identifier.Identifier.value
Id
Identifier.value
Type
Cardinality
0 - 1
Definition
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comment
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 [http://hl7.org/fhir/StructureDefinition/rendered-value](http://hl7.org/fhir/extensions/StructureDefinition-rendered-value.html)). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ident-1
Path
ExplanationOfBenefit.prescription.Reference.identifier.Identifier.period
Id
Identifier.period
Type
Cardinality
0 - 1
Definition
Time period during which identifier is/was valid for use.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.prescription.Reference.identifier.Identifier.period.Period.start
Id
Period.start
Type
Cardinality
0 - 1
Definition
The start of the period. The boundary is inclusive.
Comment
If the low element is missing, the meaning is that the low boundary is not known.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
ExplanationOfBenefit.prescription.Reference.identifier.Identifier.period.Period.end
Id
Period.end
Type
Cardinality
0 - 1
Definition
The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. 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.
Comment
The end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
ExplanationOfBenefit.prescription.Reference.identifier.Identifier.assigner
Id
Identifier.assigner
Type
Cardinality
0 - 1
Definition
Organization that issued/manages the identifier.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.prescription.Reference.identifier.Identifier.assigner.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
ref-1
Path
ExplanationOfBenefit.prescription.Reference.identifier.Identifier.assigner.Reference.type
Id
Reference.type
Type
Cardinality
0 - 1
Definition
The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comment
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.
Binding
Strength
extensible
Description
Aa resource (or, for logical models, the URI of the logical model).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.prescription.Reference.identifier.Identifier.assigner.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.
Comment
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.
Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.prescription.Reference.identifier.Identifier.assigner.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.prescription.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.originalPrescription
Id
ExplanationOfBenefit.originalPrescription
Type
Cardinality
0 - 1
Definition
Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products.
Comment
For example, a physician may prescribe a medication which the pharmacy determines is contraindicated, or for which the patient has an intolerance, and therefor issues a new prescription for an alternate medication which has the same therapeutic intent. The prescription from the pharmacy becomes the 'prescription' and that from the physician becomes the 'original prescription'.
Requirements
Often required when a fulfiller varies what is fulfilled from that authorized on the original prescription.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.originalPrescription.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
ref-1
Path
ExplanationOfBenefit.originalPrescription.Reference.type
Id
Reference.type
Type
Cardinality
0 - 1
Definition
The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comment
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.
Binding
Strength
extensible
Description
Aa resource (or, for logical models, the URI of the logical model).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.originalPrescription.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.
Comment
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.
Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.originalPrescription.Reference.identifier.Identifier.use
Id
Identifier.use
Type
Cardinality
0 - 1
Definition
The purpose of this identifier.
Comment
Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Requirements
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Binding
Strength
required
Description
Identifies the purpose for this identifier, if known .
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.originalPrescription.Reference.identifier.Identifier.type
Id
Identifier.type
Type
Cardinality
0 - 1
Definition
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Comment
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.
Requirements
Allows users to make use of identifiers when the identifier system is not known.
Binding
Strength
extensible
Description
A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.originalPrescription.Reference.identifier.Identifier.type.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.originalPrescription.Reference.identifier.Identifier.system
Id
Identifier.system
Type
Cardinality
0 - 1
Definition
Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.
Comment
Identifier.system is always case sensitive.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.originalPrescription.Reference.identifier.Identifier.value
Id
Identifier.value
Type
Cardinality
0 - 1
Definition
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comment
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 [http://hl7.org/fhir/StructureDefinition/rendered-value](http://hl7.org/fhir/extensions/StructureDefinition-rendered-value.html)). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ident-1
Path
ExplanationOfBenefit.originalPrescription.Reference.identifier.Identifier.period
Id
Identifier.period
Type
Cardinality
0 - 1
Definition
Time period during which identifier is/was valid for use.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.originalPrescription.Reference.identifier.Identifier.period.Period.start
Id
Period.start
Type
Cardinality
0 - 1
Definition
The start of the period. The boundary is inclusive.
Comment
If the low element is missing, the meaning is that the low boundary is not known.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
ExplanationOfBenefit.originalPrescription.Reference.identifier.Identifier.period.Period.end
Id
Period.end
Type
Cardinality
0 - 1
Definition
The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. 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.
Comment
The end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
ExplanationOfBenefit.originalPrescription.Reference.identifier.Identifier.assigner
Id
Identifier.assigner
Type
Cardinality
0 - 1
Definition
Organization that issued/manages the identifier.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.originalPrescription.Reference.identifier.Identifier.assigner.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
ref-1
Path
ExplanationOfBenefit.originalPrescription.Reference.identifier.Identifier.assigner.Reference.type
Id
Reference.type
Type
Cardinality
0 - 1
Definition
The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comment
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.
Binding
Strength
extensible
Description
Aa resource (or, for logical models, the URI of the logical model).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.originalPrescription.Reference.identifier.Identifier.assigner.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.
Comment
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.
Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.originalPrescription.Reference.identifier.Identifier.assigner.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.originalPrescription.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.event
Id
ExplanationOfBenefit.event
Type
Cardinality
0 - *
Definition
Information code for an event with a corresponding date or period.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.event.type
Id
ExplanationOfBenefit.event.type
Type
Cardinality
1 - 1
Definition
A coded event such as when a service is expected or a card printed.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.event.type.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.event.type.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
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 be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.event.type.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.event.type.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
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).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.event.type.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.event.type.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
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.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.event.when[x]
Id
ExplanationOfBenefit.event.when[x]
Type
Cardinality
1 - 1
Definition
A date or period in the past or future indicating when the event occurred or is expectd to occur.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.payee
Id
ExplanationOfBenefit.payee
Type
Cardinality
0 - 1
Definition
The party to be reimbursed for cost of the products and services according to the terms of the policy.
Comment
Often providers agree to receive the benefits payable to reduce the near-term costs to the patient. The insurer may decline to pay the provider and may choose to pay the subscriber instead.
Requirements
The provider needs to specify who they wish to be reimbursed and the claims processor needs express who they will reimburse.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.payee.type
Id
ExplanationOfBenefit.payee.type
Type
Cardinality
0 - 1
Definition
Type of Party to be reimbursed: Subscriber, provider, other.
Comment
Requirements
Need to know who should receive payment with the most common situations being the Provider (assignment of benefits) or the Subscriber.
Binding
Strength
example
Description
A code for the party to be reimbursed.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.payee.type.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.payee.type.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
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 be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.payee.type.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.payee.type.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
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).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.payee.type.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.payee.type.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
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.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.payee.party
Id
ExplanationOfBenefit.payee.party
Type
Cardinality
0 - 1
Definition
Reference to the individual or organization to whom any payment will be made.
Comment
Not required if the payee is 'subscriber' or 'provider'.
Requirements
Need to provide demographics if the payee is not 'subscriber' nor 'provider'.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.payee.party.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
ref-1
Path
ExplanationOfBenefit.payee.party.Reference.type
Id
Reference.type
Type
Cardinality
0 - 1
Definition
The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comment
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.
Binding
Strength
extensible
Description
Aa resource (or, for logical models, the URI of the logical model).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.payee.party.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.
Comment
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.
Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.payee.party.Reference.identifier.Identifier.use
Id
Identifier.use
Type
Cardinality
0 - 1
Definition
The purpose of this identifier.
Comment
Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Requirements
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Binding
Strength
required
Description
Identifies the purpose for this identifier, if known .
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.payee.party.Reference.identifier.Identifier.type
Id
Identifier.type
Type
Cardinality
0 - 1
Definition
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Comment
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.
Requirements
Allows users to make use of identifiers when the identifier system is not known.
Binding
Strength
extensible
Description
A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.payee.party.Reference.identifier.Identifier.system
Id
Identifier.system
Type
Cardinality
0 - 1
Definition
Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.
Comment
Identifier.system is always case sensitive.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.payee.party.Reference.identifier.Identifier.value
Id
Identifier.value
Type
Cardinality
0 - 1
Definition
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comment
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 [http://hl7.org/fhir/StructureDefinition/rendered-value](http://hl7.org/fhir/extensions/StructureDefinition-rendered-value.html)). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ident-1
Path
ExplanationOfBenefit.payee.party.Reference.identifier.Identifier.period
Id
Identifier.period
Type
Cardinality
0 - 1
Definition
Time period during which identifier is/was valid for use.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.payee.party.Reference.identifier.Identifier.assigner
Id
Identifier.assigner
Type
Cardinality
0 - 1
Definition
Organization that issued/manages the identifier.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.payee.party.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.referral
Id
ExplanationOfBenefit.referral
Type
Cardinality
0 - 1
Definition
The referral information received by the claim author, it is not to be used when the author generates a referral for a patient. A copy of that referral may be provided as supporting information. Some insurers require proof of referral to pay for services or to pay specialist rates for services.
Comment
The referral resource which lists the date, practitioner, reason and other supporting information.
Requirements
Some insurers require proof of referral to pay for services or to pay specialist rates for services.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.referral.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
ref-1
Path
ExplanationOfBenefit.referral.Reference.type
Id
Reference.type
Type
Cardinality
0 - 1
Definition
The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comment
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.
Binding
Strength
extensible
Description
Aa resource (or, for logical models, the URI of the logical model).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.referral.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.
Comment
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.
Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.referral.Reference.identifier.Identifier.use
Id
Identifier.use
Type
Cardinality
0 - 1
Definition
The purpose of this identifier.
Comment
Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Requirements
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Binding
Strength
required
Description
Identifies the purpose for this identifier, if known .
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.referral.Reference.identifier.Identifier.type
Id
Identifier.type
Type
Cardinality
0 - 1
Definition
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Comment
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.
Requirements
Allows users to make use of identifiers when the identifier system is not known.
Binding
Strength
extensible
Description
A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.referral.Reference.identifier.Identifier.type.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.referral.Reference.identifier.Identifier.system
Id
Identifier.system
Type
Cardinality
0 - 1
Definition
Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.
Comment
Identifier.system is always case sensitive.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.referral.Reference.identifier.Identifier.value
Id
Identifier.value
Type
Cardinality
0 - 1
Definition
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comment
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 [http://hl7.org/fhir/StructureDefinition/rendered-value](http://hl7.org/fhir/extensions/StructureDefinition-rendered-value.html)). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ident-1
Path
ExplanationOfBenefit.referral.Reference.identifier.Identifier.period
Id
Identifier.period
Type
Cardinality
0 - 1
Definition
Time period during which identifier is/was valid for use.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.referral.Reference.identifier.Identifier.period.Period.start
Id
Period.start
Type
Cardinality
0 - 1
Definition
The start of the period. The boundary is inclusive.
Comment
If the low element is missing, the meaning is that the low boundary is not known.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
ExplanationOfBenefit.referral.Reference.identifier.Identifier.period.Period.end
Id
Period.end
Type
Cardinality
0 - 1
Definition
The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. 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.
Comment
The end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
ExplanationOfBenefit.referral.Reference.identifier.Identifier.assigner
Id
Identifier.assigner
Type
Cardinality
0 - 1
Definition
Organization that issued/manages the identifier.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.referral.Reference.identifier.Identifier.assigner.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
ref-1
Path
ExplanationOfBenefit.referral.Reference.identifier.Identifier.assigner.Reference.type
Id
Reference.type
Type
Cardinality
0 - 1
Definition
The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comment
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.
Binding
Strength
extensible
Description
Aa resource (or, for logical models, the URI of the logical model).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.referral.Reference.identifier.Identifier.assigner.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.
Comment
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.
Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.referral.Reference.identifier.Identifier.assigner.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.referral.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.encounter
Id
ExplanationOfBenefit.encounter
Type
Cardinality
0 - *
Definition
Healthcare encounters related to this claim.
Comment
Requirements
Used in some jurisdictions to link clinical events to claim items.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.encounter.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
ref-1
Path
ExplanationOfBenefit.encounter.Reference.type
Id
Reference.type
Type
Cardinality
0 - 1
Definition
The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comment
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.
Binding
Strength
extensible
Description
Aa resource (or, for logical models, the URI of the logical model).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.encounter.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.
Comment
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.
Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.encounter.Reference.identifier.Identifier.use
Id
Identifier.use
Type
Cardinality
0 - 1
Definition
The purpose of this identifier.
Comment
Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Requirements
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Binding
Strength
required
Description
Identifies the purpose for this identifier, if known .
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.encounter.Reference.identifier.Identifier.type
Id
Identifier.type
Type
Cardinality
0 - 1
Definition
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Comment
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.
Requirements
Allows users to make use of identifiers when the identifier system is not known.
Binding
Strength
extensible
Description
A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.encounter.Reference.identifier.Identifier.type.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.encounter.Reference.identifier.Identifier.system
Id
Identifier.system
Type
Cardinality
0 - 1
Definition
Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.
Comment
Identifier.system is always case sensitive.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.encounter.Reference.identifier.Identifier.value
Id
Identifier.value
Type
Cardinality
0 - 1
Definition
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comment
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 [http://hl7.org/fhir/StructureDefinition/rendered-value](http://hl7.org/fhir/extensions/StructureDefinition-rendered-value.html)). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ident-1
Path
ExplanationOfBenefit.encounter.Reference.identifier.Identifier.period
Id
Identifier.period
Type
Cardinality
0 - 1
Definition
Time period during which identifier is/was valid for use.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.encounter.Reference.identifier.Identifier.period.Period.start
Id
Period.start
Type
Cardinality
0 - 1
Definition
The start of the period. The boundary is inclusive.
Comment
If the low element is missing, the meaning is that the low boundary is not known.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
ExplanationOfBenefit.encounter.Reference.identifier.Identifier.period.Period.end
Id
Period.end
Type
Cardinality
0 - 1
Definition
The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. 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.
Comment
The end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
ExplanationOfBenefit.encounter.Reference.identifier.Identifier.assigner
Id
Identifier.assigner
Type
Cardinality
0 - 1
Definition
Organization that issued/manages the identifier.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.encounter.Reference.identifier.Identifier.assigner.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
ref-1
Path
ExplanationOfBenefit.encounter.Reference.identifier.Identifier.assigner.Reference.type
Id
Reference.type
Type
Cardinality
0 - 1
Definition
The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comment
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.
Binding
Strength
extensible
Description
Aa resource (or, for logical models, the URI of the logical model).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.encounter.Reference.identifier.Identifier.assigner.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.
Comment
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.
Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.encounter.Reference.identifier.Identifier.assigner.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.encounter.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.facility
Id
ExplanationOfBenefit.facility
Type
Cardinality
0 - 1
Definition
Facility where the services were provided.
Comment
Requirements
Insurance adjudication can be dependant on where services were delivered.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.facility.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
ref-1
Path
ExplanationOfBenefit.facility.Reference.type
Id
Reference.type
Type
Cardinality
0 - 1
Definition
The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comment
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.
Binding
Strength
extensible
Description
Aa resource (or, for logical models, the URI of the logical model).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.facility.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.
Comment
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.
Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.facility.Reference.identifier.Identifier.use
Id
Identifier.use
Type
Cardinality
0 - 1
Definition
The purpose of this identifier.
Comment
Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Requirements
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Binding
Strength
required
Description
Identifies the purpose for this identifier, if known .
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.facility.Reference.identifier.Identifier.type
Id
Identifier.type
Type
Cardinality
0 - 1
Definition
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Comment
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.
Requirements
Allows users to make use of identifiers when the identifier system is not known.
Binding
Strength
extensible
Description
A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.facility.Reference.identifier.Identifier.type.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.facility.Reference.identifier.Identifier.system
Id
Identifier.system
Type
Cardinality
0 - 1
Definition
Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.
Comment
Identifier.system is always case sensitive.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.facility.Reference.identifier.Identifier.value
Id
Identifier.value
Type
Cardinality
0 - 1
Definition
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comment
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 [http://hl7.org/fhir/StructureDefinition/rendered-value](http://hl7.org/fhir/extensions/StructureDefinition-rendered-value.html)). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ident-1
Path
ExplanationOfBenefit.facility.Reference.identifier.Identifier.period
Id
Identifier.period
Type
Cardinality
0 - 1
Definition
Time period during which identifier is/was valid for use.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.facility.Reference.identifier.Identifier.period.Period.start
Id
Period.start
Type
Cardinality
0 - 1
Definition
The start of the period. The boundary is inclusive.
Comment
If the low element is missing, the meaning is that the low boundary is not known.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
ExplanationOfBenefit.facility.Reference.identifier.Identifier.period.Period.end
Id
Period.end
Type
Cardinality
0 - 1
Definition
The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. 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.
Comment
The end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
ExplanationOfBenefit.facility.Reference.identifier.Identifier.assigner
Id
Identifier.assigner
Type
Cardinality
0 - 1
Definition
Organization that issued/manages the identifier.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.facility.Reference.identifier.Identifier.assigner.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
ref-1
Path
ExplanationOfBenefit.facility.Reference.identifier.Identifier.assigner.Reference.type
Id
Reference.type
Type
Cardinality
0 - 1
Definition
The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comment
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.
Binding
Strength
extensible
Description
Aa resource (or, for logical models, the URI of the logical model).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.facility.Reference.identifier.Identifier.assigner.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.
Comment
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.
Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.facility.Reference.identifier.Identifier.assigner.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.facility.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.claim
Id
ExplanationOfBenefit.claim
Type
Cardinality
0 - 1
Definition
The business identifier for the instance of the adjudication request: claim predetermination or preauthorization.
Comment
Requirements
To provide a link to the original adjudication request.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.claim.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
ref-1
Path
ExplanationOfBenefit.claim.Reference.type
Id
Reference.type
Type
Cardinality
0 - 1
Definition
The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comment
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.
Binding
Strength
extensible
Description
Aa resource (or, for logical models, the URI of the logical model).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.claim.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.
Comment
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.
Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.claim.Reference.identifier.Identifier.use
Id
Identifier.use
Type
Cardinality
0 - 1
Definition
The purpose of this identifier.
Comment
Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Requirements
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Binding
Strength
required
Description
Identifies the purpose for this identifier, if known .
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.claim.Reference.identifier.Identifier.type
Id
Identifier.type
Type
Cardinality
0 - 1
Definition
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Comment
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.
Requirements
Allows users to make use of identifiers when the identifier system is not known.
Binding
Strength
extensible
Description
A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.claim.Reference.identifier.Identifier.type.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.claim.Reference.identifier.Identifier.system
Id
Identifier.system
Type
Cardinality
0 - 1
Definition
Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.
Comment
Identifier.system is always case sensitive.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.claim.Reference.identifier.Identifier.value
Id
Identifier.value
Type
Cardinality
0 - 1
Definition
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comment
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 [http://hl7.org/fhir/StructureDefinition/rendered-value](http://hl7.org/fhir/extensions/StructureDefinition-rendered-value.html)). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ident-1
Path
ExplanationOfBenefit.claim.Reference.identifier.Identifier.period
Id
Identifier.period
Type
Cardinality
0 - 1
Definition
Time period during which identifier is/was valid for use.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.claim.Reference.identifier.Identifier.period.Period.start
Id
Period.start
Type
Cardinality
0 - 1
Definition
The start of the period. The boundary is inclusive.
Comment
If the low element is missing, the meaning is that the low boundary is not known.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
ExplanationOfBenefit.claim.Reference.identifier.Identifier.period.Period.end
Id
Period.end
Type
Cardinality
0 - 1
Definition
The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. 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.
Comment
The end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
ExplanationOfBenefit.claim.Reference.identifier.Identifier.assigner
Id
Identifier.assigner
Type
Cardinality
0 - 1
Definition
Organization that issued/manages the identifier.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.claim.Reference.identifier.Identifier.assigner.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
ref-1
Path
ExplanationOfBenefit.claim.Reference.identifier.Identifier.assigner.Reference.type
Id
Reference.type
Type
Cardinality
0 - 1
Definition
The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comment
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.
Binding
Strength
extensible
Description
Aa resource (or, for logical models, the URI of the logical model).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.claim.Reference.identifier.Identifier.assigner.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.
Comment
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.
Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.claim.Reference.identifier.Identifier.assigner.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.claim.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.claimResponse
Id
ExplanationOfBenefit.claimResponse
Type
Cardinality
0 - 1
Definition
The business identifier for the instance of the adjudication response: claim, predetermination or preauthorization response.
Comment
Requirements
To provide a link to the original adjudication response.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.claimResponse.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
ref-1
Path
ExplanationOfBenefit.claimResponse.Reference.type
Id
Reference.type
Type
Cardinality
0 - 1
Definition
The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comment
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.
Binding
Strength
extensible
Description
Aa resource (or, for logical models, the URI of the logical model).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.claimResponse.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.
Comment
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.
Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.claimResponse.Reference.identifier.Identifier.use
Id
Identifier.use
Type
Cardinality
0 - 1
Definition
The purpose of this identifier.
Comment
Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Requirements
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Binding
Strength
required
Description
Identifies the purpose for this identifier, if known .
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.claimResponse.Reference.identifier.Identifier.type
Id
Identifier.type
Type
Cardinality
0 - 1
Definition
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Comment
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.
Requirements
Allows users to make use of identifiers when the identifier system is not known.
Binding
Strength
extensible
Description
A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.claimResponse.Reference.identifier.Identifier.type.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.claimResponse.Reference.identifier.Identifier.system
Id
Identifier.system
Type
Cardinality
0 - 1
Definition
Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.
Comment
Identifier.system is always case sensitive.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.claimResponse.Reference.identifier.Identifier.value
Id
Identifier.value
Type
Cardinality
0 - 1
Definition
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comment
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 [http://hl7.org/fhir/StructureDefinition/rendered-value](http://hl7.org/fhir/extensions/StructureDefinition-rendered-value.html)). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ident-1
Path
ExplanationOfBenefit.claimResponse.Reference.identifier.Identifier.period
Id
Identifier.period
Type
Cardinality
0 - 1
Definition
Time period during which identifier is/was valid for use.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.claimResponse.Reference.identifier.Identifier.period.Period.start
Id
Period.start
Type
Cardinality
0 - 1
Definition
The start of the period. The boundary is inclusive.
Comment
If the low element is missing, the meaning is that the low boundary is not known.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
ExplanationOfBenefit.claimResponse.Reference.identifier.Identifier.period.Period.end
Id
Period.end
Type
Cardinality
0 - 1
Definition
The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. 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.
Comment
The end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
ExplanationOfBenefit.claimResponse.Reference.identifier.Identifier.assigner
Id
Identifier.assigner
Type
Cardinality
0 - 1
Definition
Organization that issued/manages the identifier.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.claimResponse.Reference.identifier.Identifier.assigner.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
ref-1
Path
ExplanationOfBenefit.claimResponse.Reference.identifier.Identifier.assigner.Reference.type
Id
Reference.type
Type
Cardinality
0 - 1
Definition
The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comment
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.
Binding
Strength
extensible
Description
Aa resource (or, for logical models, the URI of the logical model).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.claimResponse.Reference.identifier.Identifier.assigner.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.
Comment
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.
Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.claimResponse.Reference.identifier.Identifier.assigner.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.claimResponse.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.outcome
Id
ExplanationOfBenefit.outcome
Type
Cardinality
1 - 1
Definition
The outcome of the claim, predetermination, or preauthorization processing.
Comment
The resource may be used to indicate that the Claim/Preauthorization/Pre-determination has been received but processing has not begun (queued); that it has been processed and one or more errors have been detected (error); no errors were detected and some of the adjudication processing has been performed (partial); or all of the adjudication processing has completed without errors (complete).
Requirements
To advise the requestor of an overall processing outcome.
Binding
Strength
required
Description
The result of the claim processing.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.decision
Id
ExplanationOfBenefit.decision
Type
Cardinality
0 - 1
Definition
The result of the claim, predetermination, or preauthorization adjudication.
Comment
The element is used to indicate the current state of the adjudication overall for the claim resource, for example: the request has been held (pended) for adjudication processing, for manual review or other reasons; that it has been processed and will be paid, or the outstanding paid, as submitted (approved); that no amount will be paid (denied); or that some amount between zero and the submitted amoutn will be paid (partial).
Requirements
To advise the requestor of the result of the adjudication process.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.decision.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.decision.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
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 be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.decision.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.decision.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
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).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.decision.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.decision.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
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.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.disposition
Id
ExplanationOfBenefit.disposition
Type
Cardinality
0 - 1
Definition
A human readable description of the status of the adjudication.
Comment
Requirements
Provided for user display.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.preAuthRef
Id
ExplanationOfBenefit.preAuthRef
Type
Cardinality
0 - *
Definition
Reference from the Insurer which is used in later communications which refers to this adjudication.
Comment
This value is only present on preauthorization adjudications.
Requirements
On subsequent claims, the insurer may require the provider to quote this value.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.preAuthRefPeriod
Id
ExplanationOfBenefit.preAuthRefPeriod
Type
Cardinality
0 - *
Definition
The timeframe during which the supplied preauthorization reference may be quoted on claims to obtain the adjudication as provided.
Comment
This value is only present on preauthorization adjudications.
Requirements
On subsequent claims, the insurer may require the provider to quote this value.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.preAuthRefPeriod.Period.start
Id
Period.start
Type
Cardinality
0 - 1
Definition
The start of the period. The boundary is inclusive.
Comment
If the low element is missing, the meaning is that the low boundary is not known.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
ExplanationOfBenefit.preAuthRefPeriod.Period.end
Id
Period.end
Type
Cardinality
0 - 1
Definition
The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. 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.
Comment
The end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
ExplanationOfBenefit.diagnosisRelatedGroup
Id
ExplanationOfBenefit.diagnosisRelatedGroup
Type
Cardinality
0 - 1
Definition
A package billing code or bundle code used to group products and services to a particular health condition (such as heart attack) which is based on a predetermined grouping code system.
Comment
For example DRG (Diagnosis Related Group) or a bundled billing code. A patient may have a diagnosis of a Myocardial Infarction and a DRG for HeartAttack would be assigned. The Claim item (and possible subsequent claims) would refer to the DRG for those line items that were for services related to the heart attack event.
Requirements
Required to relate the current diagnosis to a package billing code that is then referenced on the individual claim items which are specific to the health condition covered by the package code.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.diagnosisRelatedGroup.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.diagnosisRelatedGroup.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
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 be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.diagnosisRelatedGroup.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.diagnosisRelatedGroup.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
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).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.diagnosisRelatedGroup.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.diagnosisRelatedGroup.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
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.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.careTeam
Id
ExplanationOfBenefit.careTeam
Type
Cardinality
0 - *
Definition
The members of the team who provided the products and services.
Comment
Requirements
Common to identify the responsible and supporting practitioners.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.careTeam.sequence
Id
ExplanationOfBenefit.careTeam.sequence
Type
Cardinality
1 - 1
Definition
A number to uniquely identify care team entries.
Comment
Requirements
Necessary to maintain the order of the care team and provide a mechanism to link individuals to claim details.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.careTeam.provider
Id
ExplanationOfBenefit.careTeam.provider
Type
Cardinality
1 - 1
Definition
Member of the team who provided the product or service.
Comment
Requirements
Often a regulatory requirement to specify the responsible provider.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.careTeam.provider.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
ref-1
Path
ExplanationOfBenefit.careTeam.provider.Reference.type
Id
Reference.type
Type
Cardinality
0 - 1
Definition
The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comment
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.
Binding
Strength
extensible
Description
Aa resource (or, for logical models, the URI of the logical model).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.careTeam.provider.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.
Comment
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.
Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.careTeam.provider.Reference.identifier.Identifier.use
Id
Identifier.use
Type
Cardinality
0 - 1
Definition
The purpose of this identifier.
Comment
Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Requirements
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Binding
Strength
required
Description
Identifies the purpose for this identifier, if known .
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.careTeam.provider.Reference.identifier.Identifier.type
Id
Identifier.type
Type
Cardinality
0 - 1
Definition
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Comment
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.
Requirements
Allows users to make use of identifiers when the identifier system is not known.
Binding
Strength
extensible
Description
A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.careTeam.provider.Reference.identifier.Identifier.system
Id
Identifier.system
Type
Cardinality
0 - 1
Definition
Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.
Comment
Identifier.system is always case sensitive.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.careTeam.provider.Reference.identifier.Identifier.value
Id
Identifier.value
Type
Cardinality
0 - 1
Definition
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comment
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 [http://hl7.org/fhir/StructureDefinition/rendered-value](http://hl7.org/fhir/extensions/StructureDefinition-rendered-value.html)). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ident-1
Path
ExplanationOfBenefit.careTeam.provider.Reference.identifier.Identifier.period
Id
Identifier.period
Type
Cardinality
0 - 1
Definition
Time period during which identifier is/was valid for use.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.careTeam.provider.Reference.identifier.Identifier.assigner
Id
Identifier.assigner
Type
Cardinality
0 - 1
Definition
Organization that issued/manages the identifier.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.careTeam.provider.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.careTeam.responsible
Id
ExplanationOfBenefit.careTeam.responsible
Type
Cardinality
0 - 1
Definition
The party who is billing and/or responsible for the claimed products or services.
Comment
Responsible might not be required when there is only a single provider listed.
Requirements
When multiple parties are present it is required to distinguish the lead or responsible individual.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.careTeam.role
Id
ExplanationOfBenefit.careTeam.role
Type
Cardinality
0 - 1
Definition
The lead, assisting or supervising practitioner and their discipline if a multidisciplinary team.
Comment
Role might not be required when there is only a single provider listed.
Requirements
When multiple parties are present it is required to distinguish the roles performed by each member.
Binding
Strength
example
Description
The role codes for the care team members.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.careTeam.role.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.careTeam.role.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
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 be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.careTeam.role.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.careTeam.role.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
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).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.careTeam.role.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.careTeam.role.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
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.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.careTeam.specialty
Id
ExplanationOfBenefit.careTeam.specialty
Type
Cardinality
0 - 1
Definition
The specialization of the practitioner or provider which is applicable for this service.
Comment
Requirements
Need to specify which specialization a practitioner or provider acting under when delivering the product or service.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.careTeam.specialty.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.careTeam.specialty.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
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 be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.careTeam.specialty.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.careTeam.specialty.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
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).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.careTeam.specialty.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.careTeam.specialty.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
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.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.supportingInfo
Id
ExplanationOfBenefit.supportingInfo
Type
Cardinality
0 - *
Definition
Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues.
Comment
Often there are multiple jurisdiction specific valuesets which are required.
Requirements
Typically these information codes are required to support the services rendered or the adjudication of the services rendered.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.supportingInfo.sequence
Id
ExplanationOfBenefit.supportingInfo.sequence
Type
Cardinality
1 - 1
Definition
A number to uniquely identify supporting information entries.
Comment
Requirements
Necessary to maintain the order of the supporting information items and provide a mechanism to link to claim details.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.supportingInfo.category
Id
ExplanationOfBenefit.supportingInfo.category
Type
Cardinality
1 - 1
Definition
The general class of the information supplied: information; exception; accident, employment; onset, etc.
Comment
This may contain a category for the local bill type codes.
Requirements
Required to group or associate information items with common characteristics. For example: admission information or prior treatments.
Binding
Strength
example
Description
The valuset used for additional information category codes.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.supportingInfo.category.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.supportingInfo.category.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
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 be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.supportingInfo.category.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.supportingInfo.category.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
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).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.supportingInfo.category.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.supportingInfo.category.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
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.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.supportingInfo.code
Id
ExplanationOfBenefit.supportingInfo.code
Type
Cardinality
0 - 1
Definition
System and code pertaining to the specific information regarding special conditions relating to the setting, treatment or patient for which care is sought.
Comment
This may contain the local bill type codes such as the US UB-04 bill type code.
Requirements
Required to identify the kind of additional information.
Binding
Strength
example
Description
The valuset used for additional information codes.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.supportingInfo.code.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.supportingInfo.code.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
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 be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.supportingInfo.code.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.supportingInfo.code.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
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).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.supportingInfo.code.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.supportingInfo.code.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
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.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.supportingInfo.timing[x]
Id
ExplanationOfBenefit.supportingInfo.timing[x]
Type
Cardinality
0 - 1
Definition
The date when or period to which this information refers.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.supportingInfo.value[x]
Id
ExplanationOfBenefit.supportingInfo.value[x]
Type
Cardinality
0 - 1
Definition
Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.
Comment
Could be used to provide references to other resources, document. For example, could contain a PDF in an Attachment of the Police Report for an Accident.
Requirements
To convey the data content to be provided when the information is more than a simple code or period.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.supportingInfo.reason
Id
ExplanationOfBenefit.supportingInfo.reason
Type
Cardinality
0 - 1
Definition
Provides the reason in the situation where a reason code is required in addition to the content.
Comment
For example: the reason for the additional stay, or why a tooth is missing.
Requirements
Needed when the supporting information has both a date and amount/value and requires explanation.
Binding
Strength
example
Description
Reason codes for the missing teeth.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.supportingInfo.reason.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
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 be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.supportingInfo.reason.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.supportingInfo.reason.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
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).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.supportingInfo.reason.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.supportingInfo.reason.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
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.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.diagnosis
Id
ExplanationOfBenefit.diagnosis
Type
Cardinality
0 - *
Definition
Information about diagnoses relevant to the claim items.
Comment
Requirements
Required for the adjudication by provided context for the services and product listed.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.diagnosis.sequence
Id
ExplanationOfBenefit.diagnosis.sequence
Type
Cardinality
1 - 1
Definition
A number to uniquely identify diagnosis entries.
Comment
Diagnosis are presented in list order to their expected importance: primary, secondary, etc.
Requirements
Necessary to maintain the order of the diagnosis items and provide a mechanism to link to claim details.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.diagnosis.diagnosis[x]
Id
ExplanationOfBenefit.diagnosis.diagnosis[x]
Type
Cardinality
1 - 1
Definition
The nature of illness or problem in a coded form or as a reference to an external defined Condition.
Comment
Requirements
Provides health context for the evaluation of the products and/or services.
Binding
Strength
example
Description
ICD10 Diagnostic codes.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.diagnosis.diagnosis[x].CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.diagnosis.diagnosis[x].CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
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 be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.diagnosis.diagnosis[x].CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.diagnosis.diagnosis[x].CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
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).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.diagnosis.diagnosis[x].CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.diagnosis.diagnosis[x].CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
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.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.diagnosis.type
Id
ExplanationOfBenefit.diagnosis.type
Type
Cardinality
0 - *
Definition
When the condition was observed or the relative ranking.
Comment
For example: admitting, primary, secondary, discharge.
Requirements
Often required to capture a particular diagnosis, for example: primary or discharge.
Binding
Strength
example
Description
The type of the diagnosis: admitting, principal, discharge.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.diagnosis.type.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.diagnosis.type.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
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 be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.diagnosis.type.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.diagnosis.type.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
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).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.diagnosis.type.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.diagnosis.type.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
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.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.diagnosis.onAdmission
Id
ExplanationOfBenefit.diagnosis.onAdmission
Type
Cardinality
0 - 1
Definition
Indication of whether the diagnosis was present on admission to a facility.
Comment
Requirements
Many systems need to understand for adjudication if the diagnosis was present a time of admission.
Binding
Strength
example
Description
Present on admission.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.diagnosis.onAdmission.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.diagnosis.onAdmission.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
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 be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.diagnosis.onAdmission.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.diagnosis.onAdmission.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
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).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.diagnosis.onAdmission.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.diagnosis.onAdmission.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
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.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.procedure
Id
ExplanationOfBenefit.procedure
Type
Cardinality
0 - *
Definition
Procedures performed on the patient relevant to the billing items with the claim.
Comment
Requirements
The specific clinical invention are sometimes required to be provided to justify billing a greater than customary amount for a service.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.procedure.sequence
Id
ExplanationOfBenefit.procedure.sequence
Type
Cardinality
1 - 1
Definition
A number to uniquely identify procedure entries.
Comment
Requirements
Necessary to provide a mechanism to link to claim details.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.procedure.type
Id
ExplanationOfBenefit.procedure.type
Type
Cardinality
0 - *
Definition
When the condition was observed or the relative ranking.
Comment
Requirements
Often required to capture a particular diagnosis, for example: primary or discharge.
Binding
Strength
example
Description
Example procedure type codes.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.procedure.type.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.procedure.type.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
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 be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.procedure.type.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.procedure.type.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
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).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.procedure.type.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.procedure.type.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
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.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.procedure.date
Id
ExplanationOfBenefit.procedure.date
Type
Cardinality
0 - 1
Definition
Date and optionally time the procedure was performed.
Comment
Requirements
Required for auditing purposes.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.procedure.procedure[x]
Id
ExplanationOfBenefit.procedure.procedure[x]
Type
Cardinality
1 - 1
Definition
The code or reference to a Procedure resource which identifies the clinical intervention performed.
Comment
Requirements
This identifies the actual clinical procedure.
Binding
Strength
example
Description
ICD10 Procedure codes.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.procedure.procedure[x].CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.procedure.procedure[x].CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
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 be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.procedure.procedure[x].CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.procedure.procedure[x].CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
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).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.procedure.procedure[x].CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.procedure.procedure[x].CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
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.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.procedure.udi
Id
ExplanationOfBenefit.procedure.udi
Type
Cardinality
0 - *
Definition
Unique Device Identifiers associated with this line item.
Comment
Requirements
The UDI code allows the insurer to obtain device level information on the product supplied.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.procedure.udi.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
ref-1
Path
ExplanationOfBenefit.procedure.udi.Reference.type
Id
Reference.type
Type
Cardinality
0 - 1
Definition
The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comment
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.
Binding
Strength
extensible
Description
Aa resource (or, for logical models, the URI of the logical model).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.procedure.udi.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.
Comment
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.
Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.procedure.udi.Reference.identifier.Identifier.use
Id
Identifier.use
Type
Cardinality
0 - 1
Definition
The purpose of this identifier.
Comment
Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Requirements
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Binding
Strength
required
Description
Identifies the purpose for this identifier, if known .
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.procedure.udi.Reference.identifier.Identifier.type
Id
Identifier.type
Type
Cardinality
0 - 1
Definition
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Comment
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.
Requirements
Allows users to make use of identifiers when the identifier system is not known.
Binding
Strength
extensible
Description
A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.procedure.udi.Reference.identifier.Identifier.system
Id
Identifier.system
Type
Cardinality
0 - 1
Definition
Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.
Comment
Identifier.system is always case sensitive.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.procedure.udi.Reference.identifier.Identifier.value
Id
Identifier.value
Type
Cardinality
0 - 1
Definition
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comment
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 [http://hl7.org/fhir/StructureDefinition/rendered-value](http://hl7.org/fhir/extensions/StructureDefinition-rendered-value.html)). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ident-1
Path
ExplanationOfBenefit.procedure.udi.Reference.identifier.Identifier.period
Id
Identifier.period
Type
Cardinality
0 - 1
Definition
Time period during which identifier is/was valid for use.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.procedure.udi.Reference.identifier.Identifier.assigner
Id
Identifier.assigner
Type
Cardinality
0 - 1
Definition
Organization that issued/manages the identifier.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.procedure.udi.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.precedence
Id
ExplanationOfBenefit.precedence
Type
Cardinality
0 - 1
Definition
This indicates the relative order of a series of EOBs related to different coverages for the same suite of services.
Comment
Requirements
Needed to coordinate between multiple EOBs for the same suite of services.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.insurance
Id
ExplanationOfBenefit.insurance
Type
Cardinality
0 - *
Definition
Financial instruments for reimbursement for the health care products and services specified on the claim.
Comment
All insurance coverages for the patient which may be applicable for reimbursement, of the products and services listed in the claim, are typically provided in the claim to allow insurers to confirm the ordering of the insurance coverages relative to local 'coordination of benefit' rules. One coverage (and only one) with 'focal=true' is to be used in the adjudication of this claim. Coverages appearing before the focal Coverage in the list, and where 'Coverage.subrogation=false', should provide a reference to the ClaimResponse containing the adjudication results of the prior claim.
Requirements
At least one insurer is required for a claim to be a claim.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.insurance.focal
Id
ExplanationOfBenefit.insurance.focal
Type
Cardinality
1 - 1
Definition
A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true.
Comment
A patient may (will) have multiple insurance policies which provide reimbursement for healthcare services and products. For example, a person may also be covered by their spouse's policy and both appear in the list (and may be from the same insurer). This flag will be set to true for only one of the listed policies and that policy will be used for adjudicating this claim. Other claims would be created to request adjudication against the other listed policies.
Requirements
To identify which coverage in the list is being used to adjudicate this claim.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.insurance.coverage
Id
ExplanationOfBenefit.insurance.coverage
Type
Cardinality
1 - 1
Definition
Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system.
Comment
Requirements
Required to allow the adjudicator to locate the correct policy and history within their information system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.insurance.coverage.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
ref-1
Path
ExplanationOfBenefit.insurance.coverage.Reference.type
Id
Reference.type
Type
Cardinality
0 - 1
Definition
The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comment
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.
Binding
Strength
extensible
Description
Aa resource (or, for logical models, the URI of the logical model).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.insurance.coverage.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.
Comment
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.
Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.insurance.coverage.Reference.identifier.Identifier.use
Id
Identifier.use
Type
Cardinality
0 - 1
Definition
The purpose of this identifier.
Comment
Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Requirements
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Binding
Strength
required
Description
Identifies the purpose for this identifier, if known .
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.insurance.coverage.Reference.identifier.Identifier.type
Id
Identifier.type
Type
Cardinality
0 - 1
Definition
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Comment
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.
Requirements
Allows users to make use of identifiers when the identifier system is not known.
Binding
Strength
extensible
Description
A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.insurance.coverage.Reference.identifier.Identifier.system
Id
Identifier.system
Type
Cardinality
0 - 1
Definition
Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.
Comment
Identifier.system is always case sensitive.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.insurance.coverage.Reference.identifier.Identifier.value
Id
Identifier.value
Type
Cardinality
0 - 1
Definition
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comment
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 [http://hl7.org/fhir/StructureDefinition/rendered-value](http://hl7.org/fhir/extensions/StructureDefinition-rendered-value.html)). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ident-1
Path
ExplanationOfBenefit.insurance.coverage.Reference.identifier.Identifier.period
Id
Identifier.period
Type
Cardinality
0 - 1
Definition
Time period during which identifier is/was valid for use.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.insurance.coverage.Reference.identifier.Identifier.assigner
Id
Identifier.assigner
Type
Cardinality
0 - 1
Definition
Organization that issued/manages the identifier.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.insurance.coverage.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.insurance.preAuthRef
Id
ExplanationOfBenefit.insurance.preAuthRef
Type
Cardinality
0 - *
Definition
Reference numbers previously provided by the insurer to the provider to be quoted on subsequent claims containing services or products related to the prior authorization.
Comment
This value is an alphanumeric string that may be provided over the phone, via text, via paper, or within a ClaimResponse resource and is not a FHIR Identifier.
Requirements
Providers must quote previously issued authorization reference numbers in order to obtain adjudication as previously advised on the Preauthorization.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.accident
Id
ExplanationOfBenefit.accident
Type
Cardinality
0 - 1
Definition
Details of a accident which resulted in injuries which required the products and services listed in the claim.
Comment
Requirements
When healthcare products and services are accident related, benefits may be payable under accident provisions of policies, such as automotive, etc before they are payable under normal health insurance.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.accident.date
Id
ExplanationOfBenefit.accident.date
Type
Cardinality
0 - 1
Definition
Date of an accident event related to the products and services contained in the claim.
Comment
The date of the accident has to precede the dates of the products and services but within a reasonable timeframe.
Requirements
Required for audit purposes and adjudication.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.accident.type
Id
ExplanationOfBenefit.accident.type
Type
Cardinality
0 - 1
Definition
The type or context of the accident event for the purposes of selection of potential insurance coverages and determination of coordination between insurers.
Comment
Requirements
Coverage may be dependant on the type of accident.
Binding
Strength
extensible
Description
Type of accident: work place, auto, etc.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.accident.type.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.accident.type.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
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 be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.accident.type.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.accident.type.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
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).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.accident.type.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.accident.type.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
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.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.accident.location[x]
Id
ExplanationOfBenefit.accident.location[x]
Type
Cardinality
0 - 1
Definition
The physical location of the accident event.
Comment
Requirements
Required for audit purposes and determination of applicable insurance liability.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.accident.location[x].Address.use
Id
Address.use
Type
Cardinality
0 - 1
Definition
The purpose of this address.
Comment
Applications can assume that an address is current unless it explicitly says that it is temporary or old.
Requirements
Allows an appropriate address to be chosen from a list of many.
Binding
Strength
required
Description
The use of an address (home / work / etc.).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.accident.location[x].Address.type
Id
Address.type
Type
Cardinality
0 - 1
Definition
Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.
Comment
The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the [Location](location.html#) resource).
Binding
Strength
required
Description
The type of an address (physical / postal).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.accident.location[x].Address.line
Id
Address.line
Type
Cardinality
0 - *
Definition
This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.accident.location[x].Address.city
Id
Address.city
Type
Cardinality
0 - 1
Definition
The name of the city, town, suburb, village or other community or delivery center.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.accident.location[x].Address.district
Id
Address.district
Type
Cardinality
0 - 1
Definition
The name of the administrative area (county).
Comment
District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.accident.location[x].Address.state
Id
Address.state
Type
Cardinality
0 - 1
Definition
Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.accident.location[x].Address.postalCode
Id
Address.postalCode
Type
Cardinality
0 - 1
Definition
A postal code designating a region defined by the postal service.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.accident.location[x].Address.country
Id
Address.country
Type
Cardinality
0 - 1
Definition
Country - a nation as commonly understood or generally accepted.
Comment
ISO 3166 2- or 3- letter codes MAY be used in place of a human readable country name.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.accident.location[x].Address.period
Id
Address.period
Type
Cardinality
0 - 1
Definition
Time period when address was/is in use.
Comment
Requirements
Allows addresses to be placed in historical context.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.accident.location[x].Address.period.Period.start
Id
Period.start
Type
Cardinality
0 - 1
Definition
The start of the period. The boundary is inclusive.
Comment
If the low element is missing, the meaning is that the low boundary is not known.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
ExplanationOfBenefit.accident.location[x].Address.period.Period.end
Id
Period.end
Type
Cardinality
0 - 1
Definition
The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. 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.
Comment
The end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
ExplanationOfBenefit.patientPaid
Id
ExplanationOfBenefit.patientPaid
Type
Cardinality
0 - 1
Definition
The amount paid by the patient, in total at the claim claim level or specifically for the item and detail level, to the provider for goods and services.
Comment
Requirements
Necessary to demonstrate that copayments, co-insurance and similar patient payments have been made or accounted for.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.patientPaid.Money.value
Id
Money.value
Type
Cardinality
0 - 1
Definition
Numerical value (with implicit precision).
Comment
Monetary values have their own rules for handling precision (refer to standard accounting text books).
Requirements
The amount of the currency. The value includes an implicit precision in the presentation of the value.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.patientPaid.Money.currency
Id
Money.currency
Type
Cardinality
0 - 1
Definition
ISO 4217 Currency Code.
Comment
Requirements
A code indicating the currency, taken from ISO 4217.
Binding
Strength
required
Description
A code indicating the currency, taken from ISO 4217.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item
Id
ExplanationOfBenefit.item
Type
Cardinality
0 - *
Definition
A claim line. Either a simple (a product or service) or a 'group' of details which can also be a simple items or groups of sub-details.
Comment
Requirements
The items to be processed for adjudication.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.sequence
Id
ExplanationOfBenefit.item.sequence
Type
Cardinality
1 - 1
Definition
A number to uniquely identify item entries.
Comment
Requirements
Necessary to provide a mechanism to link to items from within the claim and within the adjudication details of the ClaimResponse.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.careTeamSequence
Id
ExplanationOfBenefit.item.careTeamSequence
Type
Cardinality
0 - *
Definition
Care team members related to this service or product.
Comment
Requirements
Need to identify the individuals and their roles in the provision of the product or service.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.diagnosisSequence
Id
ExplanationOfBenefit.item.diagnosisSequence
Type
Cardinality
0 - *
Definition
Diagnoses applicable for this service or product.
Comment
Requirements
Need to related the product or service to the associated diagnoses.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.procedureSequence
Id
ExplanationOfBenefit.item.procedureSequence
Type
Cardinality
0 - *
Definition
Procedures applicable for this service or product.
Comment
Requirements
Need to provide any listed specific procedures to support the product or service being claimed.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.informationSequence
Id
ExplanationOfBenefit.item.informationSequence
Type
Cardinality
0 - *
Definition
Exceptions, special conditions and supporting information applicable for this service or product.
Comment
Requirements
Need to reference the supporting information items that relate directly to this product or service.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.traceNumber
Id
ExplanationOfBenefit.item.traceNumber
Type
Cardinality
0 - *
Definition
Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.
Comment
Requirements
Allows partners to uniquely identify components for tracking.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.traceNumber.Identifier.use
Id
Identifier.use
Type
Cardinality
0 - 1
Definition
The purpose of this identifier.
Comment
Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Requirements
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Binding
Strength
required
Description
Identifies the purpose for this identifier, if known .
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.traceNumber.Identifier.type
Id
Identifier.type
Type
Cardinality
0 - 1
Definition
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Comment
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.
Requirements
Allows users to make use of identifiers when the identifier system is not known.
Binding
Strength
extensible
Description
A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.traceNumber.Identifier.type.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.traceNumber.Identifier.system
Id
Identifier.system
Type
Cardinality
0 - 1
Definition
Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.
Comment
Identifier.system is always case sensitive.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.traceNumber.Identifier.value
Id
Identifier.value
Type
Cardinality
0 - 1
Definition
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comment
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 [http://hl7.org/fhir/StructureDefinition/rendered-value](http://hl7.org/fhir/extensions/StructureDefinition-rendered-value.html)). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ident-1
Path
ExplanationOfBenefit.item.traceNumber.Identifier.period
Id
Identifier.period
Type
Cardinality
0 - 1
Definition
Time period during which identifier is/was valid for use.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.traceNumber.Identifier.period.Period.start
Id
Period.start
Type
Cardinality
0 - 1
Definition
The start of the period. The boundary is inclusive.
Comment
If the low element is missing, the meaning is that the low boundary is not known.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
ExplanationOfBenefit.item.traceNumber.Identifier.period.Period.end
Id
Period.end
Type
Cardinality
0 - 1
Definition
The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. 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.
Comment
The end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
ExplanationOfBenefit.item.traceNumber.Identifier.assigner
Id
Identifier.assigner
Type
Cardinality
0 - 1
Definition
Organization that issued/manages the identifier.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.traceNumber.Identifier.assigner.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
ref-1
Path
ExplanationOfBenefit.item.traceNumber.Identifier.assigner.Reference.type
Id
Reference.type
Type
Cardinality
0 - 1
Definition
The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comment
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.
Binding
Strength
extensible
Description
Aa resource (or, for logical models, the URI of the logical model).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.traceNumber.Identifier.assigner.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.
Comment
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.
Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.item.traceNumber.Identifier.assigner.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.item.revenue
Id
ExplanationOfBenefit.item.revenue
Type
Cardinality
0 - 1
Definition
The type of revenue or cost center providing the product and/or service.
Comment
Requirements
Needed in the processing of institutional claims.
Binding
Strength
example
Description
Codes for the revenue or cost centers supplying the service and/or products.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.revenue.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.revenue.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
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 be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.revenue.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.revenue.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
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).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.item.revenue.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.item.revenue.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
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.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.category
Id
ExplanationOfBenefit.item.category
Type
Cardinality
0 - 1
Definition
Code to identify the general type of benefits under which products and services are provided.
Comment
Examples include Medical Care, Periodontics, Renal Dialysis, Vision Coverage.
Requirements
Needed in the processing of institutional claims as this allows the insurer to determine whether a facial X-Ray is for dental, orthopedic, or facial surgery purposes.
Binding
Strength
example
Description
Benefit categories such as: oral, medical, vision, oral-basic etc.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.category.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.category.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
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 be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.category.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.category.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
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).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.item.category.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.item.category.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
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.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.productOrService
Id
ExplanationOfBenefit.item.productOrService
Type
Cardinality
0 - 1
Definition
When the value is a group code then this item collects a set of related item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used.
Comment
If this is an actual service or product line, i.e. not a Group, then use code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS, USCLS, ICD10, NCPDP, DIN, RxNorm, ACHI, CCI). If a grouping item then use a group code to indicate the type of thing being grouped e.g. 'glasses' or 'compound'.
Requirements
Necessary to state what was provided or done.
Binding
Strength
example
Description
Allowable service and product codes.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.productOrService.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.productOrService.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
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 be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.productOrService.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.productOrService.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
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).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.item.productOrService.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.item.productOrService.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
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.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.productOrServiceEnd
Id
ExplanationOfBenefit.item.productOrServiceEnd
Type
Cardinality
0 - 1
Definition
This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.productOrServiceEnd.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.productOrServiceEnd.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
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 be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.productOrServiceEnd.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.productOrServiceEnd.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
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).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.item.productOrServiceEnd.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.item.productOrServiceEnd.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
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.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.request
Id
ExplanationOfBenefit.item.request
Type
Cardinality
0 - *
Definition
Request or Referral for Goods or Service to be rendered.
Comment
Requirements
May identify the service to be provided or provider authorization for the service.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.request.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
ref-1
Path
ExplanationOfBenefit.item.request.Reference.type
Id
Reference.type
Type
Cardinality
0 - 1
Definition
The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comment
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.
Binding
Strength
extensible
Description
Aa resource (or, for logical models, the URI of the logical model).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.request.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.
Comment
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.
Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.item.request.Reference.identifier.Identifier.use
Id
Identifier.use
Type
Cardinality
0 - 1
Definition
The purpose of this identifier.
Comment
Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Requirements
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Binding
Strength
required
Description
Identifies the purpose for this identifier, if known .
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.request.Reference.identifier.Identifier.type
Id
Identifier.type
Type
Cardinality
0 - 1
Definition
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Comment
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.
Requirements
Allows users to make use of identifiers when the identifier system is not known.
Binding
Strength
extensible
Description
A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.request.Reference.identifier.Identifier.system
Id
Identifier.system
Type
Cardinality
0 - 1
Definition
Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.
Comment
Identifier.system is always case sensitive.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.request.Reference.identifier.Identifier.value
Id
Identifier.value
Type
Cardinality
0 - 1
Definition
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comment
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 [http://hl7.org/fhir/StructureDefinition/rendered-value](http://hl7.org/fhir/extensions/StructureDefinition-rendered-value.html)). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ident-1
Path
ExplanationOfBenefit.item.request.Reference.identifier.Identifier.period
Id
Identifier.period
Type
Cardinality
0 - 1
Definition
Time period during which identifier is/was valid for use.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.request.Reference.identifier.Identifier.assigner
Id
Identifier.assigner
Type
Cardinality
0 - 1
Definition
Organization that issued/manages the identifier.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.request.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.item.modifier
Id
ExplanationOfBenefit.item.modifier
Type
Cardinality
0 - *
Definition
Item typification or modifiers codes to convey additional context for the product or service.
Comment
For example, in 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.
Requirements
To support inclusion of the item for adjudication or to charge an elevated fee.
Binding
Strength
example
Description
Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.modifier.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.modifier.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
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 be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.modifier.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.modifier.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
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).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.item.modifier.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.item.modifier.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
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.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.programCode
Id
ExplanationOfBenefit.item.programCode
Type
Cardinality
0 - *
Definition
Identifies the program under which this may be recovered.
Comment
For example: Neonatal program, child dental program or drug users recovery program.
Requirements
Commonly used in in the identification of publicly provided program focused on population segments or disease classifications.
Binding
Strength
example
Description
Program specific reason codes.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.programCode.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.programCode.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
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 be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.programCode.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.programCode.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
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).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.item.programCode.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.item.programCode.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
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.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.serviced[x]
Id
ExplanationOfBenefit.item.serviced[x]
Type
Cardinality
0 - 1
Definition
The date or dates when the service or product was supplied, performed or completed.
Comment
Requirements
Needed to determine whether the service or product was provided during the term of the insurance coverage.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.location[x]
Id
ExplanationOfBenefit.item.location[x]
Type
Cardinality
0 - 1
Definition
Where the product or service was provided.
Comment
Requirements
The location can alter whether the item was acceptable for insurance purposes or impact the determination of the benefit amount.
Binding
Strength
example
Description
Place where the service is rendered.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.location[x].CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.location[x].CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
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 be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.location[x].CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.location[x].CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
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).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.item.location[x].CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.item.location[x].CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
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.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.patientPaid
Id
ExplanationOfBenefit.item.patientPaid
Type
Cardinality
0 - 1
Definition
The amount paid by the patient, in total at the claim claim level or specifically for the item and detail level, to the provider for goods and services.
Comment
Requirements
Necessary to demonstrate that copayments, co-insurance and similar patient payments have been made or accounted for.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.patientPaid.Money.value
Id
Money.value
Type
Cardinality
0 - 1
Definition
Numerical value (with implicit precision).
Comment
Monetary values have their own rules for handling precision (refer to standard accounting text books).
Requirements
The amount of the currency. The value includes an implicit precision in the presentation of the value.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.patientPaid.Money.currency
Id
Money.currency
Type
Cardinality
0 - 1
Definition
ISO 4217 Currency Code.
Comment
Requirements
A code indicating the currency, taken from ISO 4217.
Binding
Strength
required
Description
A code indicating the currency, taken from ISO 4217.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.quantity
Id
ExplanationOfBenefit.item.quantity
Type
Cardinality
0 - 1
Definition
The number of repetitions of a service or product.
Comment
Requirements
Required when the product or service code does not convey the quantity provided.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.quantity.Quantity.value
Id
Quantity.value
Type
Cardinality
0 - 1
Definition
The value of the measured amount. The value includes an implicit precision in the presentation of the value.
Comment
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).
Requirements
Precision is handled implicitly in almost all cases of measurement.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.quantity.Quantity.comparator
Id
Quantity.comparator
Type
Cardinality
0 - 1
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.
Comment
Requirements
Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.
Binding
Strength
required
Description
How the Quantity should be understood and represented.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.quantity.Quantity.unit
Id
Quantity.unit
Type
Cardinality
0 - 1
Definition
A human-readable form of the unit.
Comment
Requirements
There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.quantity.Quantity.system
Id
Quantity.system
Type
Cardinality
0 - 1
Definition
The identification of the system that provides the coded form of the unit.
Comment
Requirements
Need to know the system that defines the coded form of the unit.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
qty-3
Path
ExplanationOfBenefit.item.quantity.Quantity.code
Id
Quantity.code
Type
Cardinality
0 - 1
Definition
A computer processable form of the unit in some unit representation system.
Comment
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.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
qty-3
Path
ExplanationOfBenefit.item.unitPrice
Id
ExplanationOfBenefit.item.unitPrice
Type
Cardinality
0 - 1
Definition
If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.
Comment
Requirements
The amount charged to the patient by the provider for a single unit.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.unitPrice.Money.value
Id
Money.value
Type
Cardinality
0 - 1
Definition
Numerical value (with implicit precision).
Comment
Monetary values have their own rules for handling precision (refer to standard accounting text books).
Requirements
The amount of the currency. The value includes an implicit precision in the presentation of the value.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.unitPrice.Money.currency
Id
Money.currency
Type
Cardinality
0 - 1
Definition
ISO 4217 Currency Code.
Comment
Requirements
A code indicating the currency, taken from ISO 4217.
Binding
Strength
required
Description
A code indicating the currency, taken from ISO 4217.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.factor
Id
ExplanationOfBenefit.item.factor
Type
Cardinality
0 - 1
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.
Comment
To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10).
Requirements
When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.tax
Id
ExplanationOfBenefit.item.tax
Type
Cardinality
0 - 1
Definition
The total of taxes applicable for this product or service.
Comment
Requirements
Required when taxes are not embedded in the unit price or provided as a separate service.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.tax.Money.value
Id
Money.value
Type
Cardinality
0 - 1
Definition
Numerical value (with implicit precision).
Comment
Monetary values have their own rules for handling precision (refer to standard accounting text books).
Requirements
The amount of the currency. The value includes an implicit precision in the presentation of the value.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.tax.Money.currency
Id
Money.currency
Type
Cardinality
0 - 1
Definition
ISO 4217 Currency Code.
Comment
Requirements
A code indicating the currency, taken from ISO 4217.
Binding
Strength
required
Description
A code indicating the currency, taken from ISO 4217.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.net
Id
ExplanationOfBenefit.item.net
Type
Cardinality
0 - 1
Definition
The total amount claimed for the group (if a grouper) or the line item. Net = unit price * quantity * factor.
Comment
For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.
Requirements
Provides the total amount claimed for the group (if a grouper) or the line item.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.net.Money.value
Id
Money.value
Type
Cardinality
0 - 1
Definition
Numerical value (with implicit precision).
Comment
Monetary values have their own rules for handling precision (refer to standard accounting text books).
Requirements
The amount of the currency. The value includes an implicit precision in the presentation of the value.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.net.Money.currency
Id
Money.currency
Type
Cardinality
0 - 1
Definition
ISO 4217 Currency Code.
Comment
Requirements
A code indicating the currency, taken from ISO 4217.
Binding
Strength
required
Description
A code indicating the currency, taken from ISO 4217.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.udi
Id
ExplanationOfBenefit.item.udi
Type
Cardinality
0 - *
Definition
Unique Device Identifiers associated with this line item.
Comment
Requirements
The UDI code allows the insurer to obtain device level information on the product supplied.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.udi.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
ref-1
Path
ExplanationOfBenefit.item.udi.Reference.type
Id
Reference.type
Type
Cardinality
0 - 1
Definition
The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comment
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.
Binding
Strength
extensible
Description
Aa resource (or, for logical models, the URI of the logical model).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.udi.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.
Comment
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.
Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.item.udi.Reference.identifier.Identifier.use
Id
Identifier.use
Type
Cardinality
0 - 1
Definition
The purpose of this identifier.
Comment
Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Requirements
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Binding
Strength
required
Description
Identifies the purpose for this identifier, if known .
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.udi.Reference.identifier.Identifier.type
Id
Identifier.type
Type
Cardinality
0 - 1
Definition
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Comment
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.
Requirements
Allows users to make use of identifiers when the identifier system is not known.
Binding
Strength
extensible
Description
A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.udi.Reference.identifier.Identifier.system
Id
Identifier.system
Type
Cardinality
0 - 1
Definition
Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.
Comment
Identifier.system is always case sensitive.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.udi.Reference.identifier.Identifier.value
Id
Identifier.value
Type
Cardinality
0 - 1
Definition
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comment
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 [http://hl7.org/fhir/StructureDefinition/rendered-value](http://hl7.org/fhir/extensions/StructureDefinition-rendered-value.html)). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ident-1
Path
ExplanationOfBenefit.item.udi.Reference.identifier.Identifier.period
Id
Identifier.period
Type
Cardinality
0 - 1
Definition
Time period during which identifier is/was valid for use.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.udi.Reference.identifier.Identifier.assigner
Id
Identifier.assigner
Type
Cardinality
0 - 1
Definition
Organization that issued/manages the identifier.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.udi.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.item.bodySite
Id
ExplanationOfBenefit.item.bodySite
Type
Cardinality
0 - *
Definition
Physical location where the service is performed or applies.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.bodySite.site
Id
ExplanationOfBenefit.item.bodySite.site
Type
Cardinality
1 - *
Definition
Physical service site on the patient (limb, tooth, etc.).
Comment
For example: Providing a tooth code, allows an insurer to identify a provider performing a filling on a tooth that was previously removed.
Requirements
Allows insurer to validate specific procedures.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.bodySite.site.CodeableReference.concept
Id
CodeableReference.concept
Type
Cardinality
0 - 1
Definition
A reference to a concept - e.g. the information is identified by its general class to the degree of precision found in the terminology.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.bodySite.site.CodeableReference.reference
Id
CodeableReference.reference
Type
Cardinality
0 - 1
Definition
A reference to a resource the provides exact details about the information being referenced.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.bodySite.subSite
Id
ExplanationOfBenefit.item.bodySite.subSite
Type
Cardinality
0 - *
Definition
A region or surface of the bodySite, e.g. limb region or tooth surface(s).
Comment
Requirements
Allows insurer to validate specific procedures.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.bodySite.subSite.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.encounter
Id
ExplanationOfBenefit.item.encounter
Type
Cardinality
0 - *
Definition
Healthcare encounters related to this claim.
Comment
Requirements
Used in some jurisdictions to link clinical events to claim items.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.encounter.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
ref-1
Path
ExplanationOfBenefit.item.encounter.Reference.type
Id
Reference.type
Type
Cardinality
0 - 1
Definition
The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comment
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.
Binding
Strength
extensible
Description
Aa resource (or, for logical models, the URI of the logical model).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.encounter.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.
Comment
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.
Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.item.encounter.Reference.identifier.Identifier.use
Id
Identifier.use
Type
Cardinality
0 - 1
Definition
The purpose of this identifier.
Comment
Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Requirements
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Binding
Strength
required
Description
Identifies the purpose for this identifier, if known .
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.encounter.Reference.identifier.Identifier.type
Id
Identifier.type
Type
Cardinality
0 - 1
Definition
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Comment
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.
Requirements
Allows users to make use of identifiers when the identifier system is not known.
Binding
Strength
extensible
Description
A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.encounter.Reference.identifier.Identifier.system
Id
Identifier.system
Type
Cardinality
0 - 1
Definition
Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.
Comment
Identifier.system is always case sensitive.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.encounter.Reference.identifier.Identifier.value
Id
Identifier.value
Type
Cardinality
0 - 1
Definition
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comment
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 [http://hl7.org/fhir/StructureDefinition/rendered-value](http://hl7.org/fhir/extensions/StructureDefinition-rendered-value.html)). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ident-1
Path
ExplanationOfBenefit.item.encounter.Reference.identifier.Identifier.period
Id
Identifier.period
Type
Cardinality
0 - 1
Definition
Time period during which identifier is/was valid for use.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.encounter.Reference.identifier.Identifier.assigner
Id
Identifier.assigner
Type
Cardinality
0 - 1
Definition
Organization that issued/manages the identifier.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.encounter.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.item.noteNumber
Id
ExplanationOfBenefit.item.noteNumber
Type
Cardinality
0 - *
Definition
The numbers associated with notes below which apply to the adjudication of this item.
Comment
Requirements
Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.reviewOutcome
Id
ExplanationOfBenefit.item.reviewOutcome
Type
Cardinality
0 - 1
Definition
The high-level results of the adjudication if adjudication has been performed.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.reviewOutcome.decision
Id
ExplanationOfBenefit.item.reviewOutcome.decision
Type
Cardinality
0 - 1
Definition
The result of the claim, predetermination, or preauthorization adjudication.
Comment
The element is used to indicate the current state of the adjudication overall for the claim resource, for example: the request has been held (pended) for adjudication processing, for manual review or other reasons; that it has been processed and will be paid, or the outstanding paid, as submitted (approved); that no amount will be paid (denied); or that some amount between zero and the submitted amount will be paid (partial).
Requirements
To advise the requestor of the result of the adjudication process.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.reviewOutcome.decision.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.reviewOutcome.reason
Id
ExplanationOfBenefit.item.reviewOutcome.reason
Type
Cardinality
0 - *
Definition
The reasons for the result of the claim, predetermination, or preauthorization adjudication.
Comment
Requirements
To advise the requestor of the contributors to the result of the adjudication process.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.reviewOutcome.reason.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.reviewOutcome.preAuthRef
Id
ExplanationOfBenefit.item.reviewOutcome.preAuthRef
Type
Cardinality
0 - 1
Definition
Reference from the Insurer which is used in later communications which refers to this adjudication.
Comment
This value is only present on preauthorization adjudications.
Requirements
On subsequent claims, the insurer may require the provider to quote this value.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.reviewOutcome.preAuthPeriod
Id
ExplanationOfBenefit.item.reviewOutcome.preAuthPeriod
Type
Cardinality
0 - 1
Definition
The time frame during which this authorization is effective.
Comment
Requirements
To convey to the provider when the authorized products and services must be supplied for the authorized adjudication to apply.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.reviewOutcome.preAuthPeriod.Period.start
Id
Period.start
Type
Cardinality
0 - 1
Definition
The start of the period. The boundary is inclusive.
Comment
If the low element is missing, the meaning is that the low boundary is not known.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
ExplanationOfBenefit.item.reviewOutcome.preAuthPeriod.Period.end
Id
Period.end
Type
Cardinality
0 - 1
Definition
The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. 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.
Comment
The end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
ExplanationOfBenefit.item.adjudication
Id
ExplanationOfBenefit.item.adjudication
Type
Cardinality
0 - *
Definition
If this item is a group then the values here are a summary of the adjudication of the detail items. If this item is a simple product or service then this is the result of the adjudication of this item.
Comment
Requirements
The adjudication results conveys the insurer's assessment of the item provided in the claim under the terms of the patient's insurance coverage.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.adjudication.category
Id
ExplanationOfBenefit.item.adjudication.category
Type
Cardinality
1 - 1
Definition
A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in-aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item.
Comment
For example, codes indicating: Co-Pay, deductible, eligible, benefit, tax, etc.
Requirements
Needed to enable understanding of the context of the other information in the adjudication.
Binding
Strength
example
Description
The adjudication codes.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.adjudication.category.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.adjudication.reason
Id
ExplanationOfBenefit.item.adjudication.reason
Type
Cardinality
0 - 1
Definition
A code supporting the understanding of the adjudication result and explaining variance from expected amount.
Comment
For example, may indicate that the funds for this benefit type have been exhausted.
Requirements
To support understanding of variance from adjudication expectations.
Binding
Strength
example
Description
Adjudication reason codes.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.adjudication.reason.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.adjudication.amount
Id
ExplanationOfBenefit.item.adjudication.amount
Type
Cardinality
0 - 1
Definition
Monetary amount associated with the category.
Comment
For example, amount submitted, eligible amount, co-payment, and benefit payable.
Requirements
Most adjudication categories convey a monetary amount.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.adjudication.amount.Money.value
Id
Money.value
Type
Cardinality
0 - 1
Definition
Numerical value (with implicit precision).
Comment
Monetary values have their own rules for handling precision (refer to standard accounting text books).
Requirements
The amount of the currency. The value includes an implicit precision in the presentation of the value.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.adjudication.amount.Money.currency
Id
Money.currency
Type
Cardinality
0 - 1
Definition
ISO 4217 Currency Code.
Comment
Requirements
A code indicating the currency, taken from ISO 4217.
Binding
Strength
required
Description
A code indicating the currency, taken from ISO 4217.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.adjudication.quantity
Id
ExplanationOfBenefit.item.adjudication.quantity
Type
Cardinality
0 - 1
Definition
A non-monetary value associated with the category. Mutually exclusive to the amount element above.
Comment
For example: eligible percentage or co-payment percentage.
Requirements
Some adjudication categories convey a percentage or a fixed value.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.adjudication.quantity.Quantity.value
Id
Quantity.value
Type
Cardinality
0 - 1
Definition
The value of the measured amount. The value includes an implicit precision in the presentation of the value.
Comment
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).
Requirements
Precision is handled implicitly in almost all cases of measurement.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.adjudication.quantity.Quantity.comparator
Id
Quantity.comparator
Type
Cardinality
0 - 1
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.
Comment
Requirements
Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.
Binding
Strength
required
Description
How the Quantity should be understood and represented.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.adjudication.quantity.Quantity.unit
Id
Quantity.unit
Type
Cardinality
0 - 1
Definition
A human-readable form of the unit.
Comment
Requirements
There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.adjudication.quantity.Quantity.system
Id
Quantity.system
Type
Cardinality
0 - 1
Definition
The identification of the system that provides the coded form of the unit.
Comment
Requirements
Need to know the system that defines the coded form of the unit.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
qty-3
Path
ExplanationOfBenefit.item.adjudication.quantity.Quantity.code
Id
Quantity.code
Type
Cardinality
0 - 1
Definition
A computer processable form of the unit in some unit representation system.
Comment
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.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
qty-3
Path
ExplanationOfBenefit.item.detail
Id
ExplanationOfBenefit.item.detail
Type
Cardinality
0 - *
Definition
Second-tier of goods and services.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.detail.sequence
Id
ExplanationOfBenefit.item.detail.sequence
Type
Cardinality
1 - 1
Definition
A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items.
Comment
Requirements
The items to be processed for adjudication.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.detail.traceNumber
Id
ExplanationOfBenefit.item.detail.traceNumber
Type
Cardinality
0 - *
Definition
Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.
Comment
Requirements
Allows partners to uniquely identify components for tracking.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.detail.traceNumber.Identifier.use
Id
Identifier.use
Type
Cardinality
0 - 1
Definition
The purpose of this identifier.
Comment
Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Requirements
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Binding
Strength
required
Description
Identifies the purpose for this identifier, if known .
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.detail.traceNumber.Identifier.type
Id
Identifier.type
Type
Cardinality
0 - 1
Definition
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Comment
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.
Requirements
Allows users to make use of identifiers when the identifier system is not known.
Binding
Strength
extensible
Description
A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.detail.traceNumber.Identifier.system
Id
Identifier.system
Type
Cardinality
0 - 1
Definition
Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.
Comment
Identifier.system is always case sensitive.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.detail.traceNumber.Identifier.value
Id
Identifier.value
Type
Cardinality
0 - 1
Definition
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comment
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 [http://hl7.org/fhir/StructureDefinition/rendered-value](http://hl7.org/fhir/extensions/StructureDefinition-rendered-value.html)). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ident-1
Path
ExplanationOfBenefit.item.detail.traceNumber.Identifier.period
Id
Identifier.period
Type
Cardinality
0 - 1
Definition
Time period during which identifier is/was valid for use.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.detail.traceNumber.Identifier.assigner
Id
Identifier.assigner
Type
Cardinality
0 - 1
Definition
Organization that issued/manages the identifier.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.detail.revenue
Id
ExplanationOfBenefit.item.detail.revenue
Type
Cardinality
0 - 1
Definition
The type of revenue or cost center providing the product and/or service.
Comment
Requirements
Needed in the processing of institutional claims.
Binding
Strength
example
Description
Codes for the revenue or cost centers supplying the service and/or products.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.detail.revenue.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.detail.category
Id
ExplanationOfBenefit.item.detail.category
Type
Cardinality
0 - 1
Definition
Code to identify the general type of benefits under which products and services are provided.
Comment
Examples include: Medical Care, Periodontics, Renal Dialysis, Vision Coverage.
Requirements
Needed in the processing of institutional claims as this allows the insurer to determine whether a facial X-Ray is for dental, orthopedic, or facial surgery purposes.
Binding
Strength
example
Description
Benefit categories such as: oral, medical, vision, oral-basic etc.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.detail.category.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.detail.productOrService
Id
ExplanationOfBenefit.item.detail.productOrService
Type
Cardinality
0 - 1
Definition
When the value is a group code then this item collects a set of related item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used.
Comment
If this is an actual service or product line, i.e. not a Group, then use code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS, USCLS, ICD10, NCPDP, DIN, RxNorm, ACHI, CCI). If a grouping item then use a group code to indicate the type of thing being grouped e.g. 'glasses' or 'compound'.
Requirements
Necessary to state what was provided or done.
Binding
Strength
example
Description
Allowable service and product codes.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.detail.productOrService.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.detail.productOrServiceEnd
Id
ExplanationOfBenefit.item.detail.productOrServiceEnd
Type
Cardinality
0 - 1
Definition
This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.detail.productOrServiceEnd.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.detail.modifier
Id
ExplanationOfBenefit.item.detail.modifier
Type
Cardinality
0 - *
Definition
Item typification or modifiers codes to convey additional context for the product or service.
Comment
For example, in 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.
Requirements
To support inclusion of the item for adjudication or to charge an elevated fee.
Binding
Strength
example
Description
Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.detail.modifier.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.detail.programCode
Id
ExplanationOfBenefit.item.detail.programCode
Type
Cardinality
0 - *
Definition
Identifies the program under which this may be recovered.
Comment
For example: Neonatal program, child dental program or drug users recovery program.
Requirements
Commonly used in in the identification of publicly provided program focused on population segments or disease classifications.
Binding
Strength
example
Description
Program specific reason codes.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.detail.programCode.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.detail.patientPaid
Id
ExplanationOfBenefit.item.detail.patientPaid
Type
Cardinality
0 - 1
Definition
The amount paid by the patient, in total at the claim claim level or specifically for the item and detail level, to the provider for goods and services.
Comment
Requirements
Necessary to demonstrate that copayments, co-insurance and similar patient payments have been made or accounted for.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.detail.patientPaid.Money.value
Id
Money.value
Type
Cardinality
0 - 1
Definition
Numerical value (with implicit precision).
Comment
Monetary values have their own rules for handling precision (refer to standard accounting text books).
Requirements
The amount of the currency. The value includes an implicit precision in the presentation of the value.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.detail.patientPaid.Money.currency
Id
Money.currency
Type
Cardinality
0 - 1
Definition
ISO 4217 Currency Code.
Comment
Requirements
A code indicating the currency, taken from ISO 4217.
Binding
Strength
required
Description
A code indicating the currency, taken from ISO 4217.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.detail.quantity
Id
ExplanationOfBenefit.item.detail.quantity
Type
Cardinality
0 - 1
Definition
The number of repetitions of a service or product.
Comment
Requirements
Required when the product or service code does not convey the quantity provided.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.detail.quantity.Quantity.value
Id
Quantity.value
Type
Cardinality
0 - 1
Definition
The value of the measured amount. The value includes an implicit precision in the presentation of the value.
Comment
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).
Requirements
Precision is handled implicitly in almost all cases of measurement.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.detail.quantity.Quantity.comparator
Id
Quantity.comparator
Type
Cardinality
0 - 1
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.
Comment
Requirements
Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.
Binding
Strength
required
Description
How the Quantity should be understood and represented.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.detail.quantity.Quantity.unit
Id
Quantity.unit
Type
Cardinality
0 - 1
Definition
A human-readable form of the unit.
Comment
Requirements
There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.detail.quantity.Quantity.system
Id
Quantity.system
Type
Cardinality
0 - 1
Definition
The identification of the system that provides the coded form of the unit.
Comment
Requirements
Need to know the system that defines the coded form of the unit.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
qty-3
Path
ExplanationOfBenefit.item.detail.quantity.Quantity.code
Id
Quantity.code
Type
Cardinality
0 - 1
Definition
A computer processable form of the unit in some unit representation system.
Comment
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.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
qty-3
Path
ExplanationOfBenefit.item.detail.unitPrice
Id
ExplanationOfBenefit.item.detail.unitPrice
Type
Cardinality
0 - 1
Definition
If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.
Comment
Requirements
The amount charged to the patient by the provider for a single unit.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.detail.unitPrice.Money.value
Id
Money.value
Type
Cardinality
0 - 1
Definition
Numerical value (with implicit precision).
Comment
Monetary values have their own rules for handling precision (refer to standard accounting text books).
Requirements
The amount of the currency. The value includes an implicit precision in the presentation of the value.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.detail.unitPrice.Money.currency
Id
Money.currency
Type
Cardinality
0 - 1
Definition
ISO 4217 Currency Code.
Comment
Requirements
A code indicating the currency, taken from ISO 4217.
Binding
Strength
required
Description
A code indicating the currency, taken from ISO 4217.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.detail.factor
Id
ExplanationOfBenefit.item.detail.factor
Type
Cardinality
0 - 1
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.
Comment
To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10).
Requirements
When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.detail.tax
Id
ExplanationOfBenefit.item.detail.tax
Type
Cardinality
0 - 1
Definition
The total of taxes applicable for this product or service.
Comment
Requirements
Required when taxes are not embedded in the unit price or provided as a separate service.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.detail.tax.Money.value
Id
Money.value
Type
Cardinality
0 - 1
Definition
Numerical value (with implicit precision).
Comment
Monetary values have their own rules for handling precision (refer to standard accounting text books).
Requirements
The amount of the currency. The value includes an implicit precision in the presentation of the value.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.detail.tax.Money.currency
Id
Money.currency
Type
Cardinality
0 - 1
Definition
ISO 4217 Currency Code.
Comment
Requirements
A code indicating the currency, taken from ISO 4217.
Binding
Strength
required
Description
A code indicating the currency, taken from ISO 4217.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.detail.net
Id
ExplanationOfBenefit.item.detail.net
Type
Cardinality
0 - 1
Definition
The total amount claimed for the group (if a grouper) or the line item.detail. Net = unit price * quantity * factor.
Comment
For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.
Requirements
Provides the total amount claimed for the group (if a grouper) or the line item.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.detail.net.Money.value
Id
Money.value
Type
Cardinality
0 - 1
Definition
Numerical value (with implicit precision).
Comment
Monetary values have their own rules for handling precision (refer to standard accounting text books).
Requirements
The amount of the currency. The value includes an implicit precision in the presentation of the value.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.detail.net.Money.currency
Id
Money.currency
Type
Cardinality
0 - 1
Definition
ISO 4217 Currency Code.
Comment
Requirements
A code indicating the currency, taken from ISO 4217.
Binding
Strength
required
Description
A code indicating the currency, taken from ISO 4217.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.detail.udi
Id
ExplanationOfBenefit.item.detail.udi
Type
Cardinality
0 - *
Definition
Unique Device Identifiers associated with this line item.
Comment
Requirements
The UDI code allows the insurer to obtain device level information on the product supplied.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.detail.udi.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
ref-1
Path
ExplanationOfBenefit.item.detail.udi.Reference.type
Id
Reference.type
Type
Cardinality
0 - 1
Definition
The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comment
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.
Binding
Strength
extensible
Description
Aa resource (or, for logical models, the URI of the logical model).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.detail.udi.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.
Comment
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.
Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.item.detail.udi.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.item.detail.noteNumber
Id
ExplanationOfBenefit.item.detail.noteNumber
Type
Cardinality
0 - *
Definition
The numbers associated with notes below which apply to the adjudication of this item.
Comment
Requirements
Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.detail.reviewOutcome
Id
ExplanationOfBenefit.item.detail.reviewOutcome
Type
Cardinality
0 - 1
Definition
The high-level results of the adjudication if adjudication has been performed.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.detail.adjudication
Id
ExplanationOfBenefit.item.detail.adjudication
Type
Cardinality
0 - *
Definition
The adjudication results.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.detail.subDetail
Id
ExplanationOfBenefit.item.detail.subDetail
Type
Cardinality
0 - *
Definition
Third-tier of goods and services.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.detail.subDetail.sequence
Id
ExplanationOfBenefit.item.detail.subDetail.sequence
Type
Cardinality
1 - 1
Definition
A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items.
Comment
Requirements
The items to be processed for adjudication.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.detail.subDetail.traceNumber
Id
ExplanationOfBenefit.item.detail.subDetail.traceNumber
Type
Cardinality
0 - *
Definition
Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.
Comment
Requirements
Allows partners to uniquely identify components for tracking.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.detail.subDetail.revenue
Id
ExplanationOfBenefit.item.detail.subDetail.revenue
Type
Cardinality
0 - 1
Definition
The type of revenue or cost center providing the product and/or service.
Comment
Requirements
Needed in the processing of institutional claims.
Binding
Strength
example
Description
Codes for the revenue or cost centers supplying the service and/or products.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.detail.subDetail.category
Id
ExplanationOfBenefit.item.detail.subDetail.category
Type
Cardinality
0 - 1
Definition
Code to identify the general type of benefits under which products and services are provided.
Comment
Examples include Medical Care, Periodontics, Renal Dialysis, Vision Coverage.
Requirements
Needed in the processing of institutional claims as this allows the insurer to determine whether a facial X-Ray is for dental, orthopedic, or facial surgery purposes.
Binding
Strength
example
Description
Benefit categories such as: oral, medical, vision, oral-basic etc.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.detail.subDetail.productOrService
Id
ExplanationOfBenefit.item.detail.subDetail.productOrService
Type
Cardinality
0 - 1
Definition
When the value is a group code then this item collects a set of related item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used.
Comment
If this is an actual service or product line, i.e. not a Group, then use code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS, USCLS, ICD10, NCPDP, DIN, RxNorm, ACHI, CCI). If a grouping item then use a group code to indicate the type of thing being grouped e.g. 'glasses' or 'compound'.
Requirements
Necessary to state what was provided or done.
Binding
Strength
example
Description
Allowable service and product codes.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.detail.subDetail.productOrServiceEnd
Id
ExplanationOfBenefit.item.detail.subDetail.productOrServiceEnd
Type
Cardinality
0 - 1
Definition
This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.detail.subDetail.modifier
Id
ExplanationOfBenefit.item.detail.subDetail.modifier
Type
Cardinality
0 - *
Definition
Item typification or modifiers codes to convey additional context for the product or service.
Comment
For example, in Oral whether the treatment is cosmetic or associated with TMJ, or for Medical whether the treatment was outside the clinic or outside of office hours.
Requirements
To support inclusion of the item for adjudication or to charge an elevated fee.
Binding
Strength
example
Description
Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.detail.subDetail.programCode
Id
ExplanationOfBenefit.item.detail.subDetail.programCode
Type
Cardinality
0 - *
Definition
Identifies the program under which this may be recovered.
Comment
For example: Neonatal program, child dental program or drug users recovery program.
Requirements
Commonly used in in the identification of publicly provided program focused on population segments or disease classifications.
Binding
Strength
example
Description
Program specific reason codes.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.detail.subDetail.patientPaid
Id
ExplanationOfBenefit.item.detail.subDetail.patientPaid
Type
Cardinality
0 - 1
Definition
The amount paid by the patient, in total at the claim claim level or specifically for the item and detail level, to the provider for goods and services.
Comment
Requirements
Necessary to demonstrate that copayments, co-insurance and similar patient payments have been made or accounted for.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.detail.subDetail.quantity
Id
ExplanationOfBenefit.item.detail.subDetail.quantity
Type
Cardinality
0 - 1
Definition
The number of repetitions of a service or product.
Comment
Requirements
Required when the product or service code does not convey the quantity provided.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.detail.subDetail.unitPrice
Id
ExplanationOfBenefit.item.detail.subDetail.unitPrice
Type
Cardinality
0 - 1
Definition
If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.
Comment
Requirements
The amount charged to the patient by the provider for a single unit.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.detail.subDetail.factor
Id
ExplanationOfBenefit.item.detail.subDetail.factor
Type
Cardinality
0 - 1
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.
Comment
To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10).
Requirements
When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.detail.subDetail.tax
Id
ExplanationOfBenefit.item.detail.subDetail.tax
Type
Cardinality
0 - 1
Definition
The total of taxes applicable for this product or service.
Comment
Requirements
Required when taxes are not embedded in the unit price or provided as a separate service.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.detail.subDetail.net
Id
ExplanationOfBenefit.item.detail.subDetail.net
Type
Cardinality
0 - 1
Definition
The total amount claimed for the line item.detail.subDetail. Net = unit price * quantity * factor.
Comment
For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.
Requirements
Provides the total amount claimed for the group (if a grouper) or the line item.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.detail.subDetail.udi
Id
ExplanationOfBenefit.item.detail.subDetail.udi
Type
Cardinality
0 - *
Definition
Unique Device Identifiers associated with this line item.
Comment
Requirements
The UDI code allows the insurer to obtain device level information on the product supplied.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.item.detail.subDetail.noteNumber
Id
ExplanationOfBenefit.item.detail.subDetail.noteNumber
Type
Cardinality
0 - *
Definition
The numbers associated with notes below which apply to the adjudication of this item.
Comment
Requirements
Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
reviewOutcome
Subdetail level adjudication results
Path
ExplanationOfBenefit.item.detail.subDetail.reviewOutcome
Id
ExplanationOfBenefit.item.detail.subDetail.reviewOutcome
Type
Cardinality
0 - 1
Definition
The high-level results of the adjudication if adjudication has been performed.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
adjudication
Subdetail level adjudication details
Path
ExplanationOfBenefit.item.detail.subDetail.adjudication
Id
ExplanationOfBenefit.item.detail.subDetail.adjudication
Type
Cardinality
0 - *
Definition
The adjudication results.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem
Id
ExplanationOfBenefit.addItem
Type
Cardinality
0 - *
Definition
The first-tier service adjudications for payor added product or service lines.
Comment
Requirements
Insurers may redefine the provided product or service or may package and/or decompose groups of products and services. The addItems allows the insurer to provide their line item list with linkage to the submitted items/details/sub-details. In a preauthorization the insurer may use the addItem structure to provide additional information on authorized products and services.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.itemSequence
Id
ExplanationOfBenefit.addItem.itemSequence
Type
Cardinality
0 - *
Definition
Claim items which this service line is intended to replace.
Comment
Requirements
Provides references to the claim items.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.detailSequence
Id
ExplanationOfBenefit.addItem.detailSequence
Type
Cardinality
0 - *
Definition
The sequence number of the details within the claim item which this line is intended to replace.
Comment
Requirements
Provides references to the claim details within the claim item.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.subDetailSequence
Id
ExplanationOfBenefit.addItem.subDetailSequence
Type
Cardinality
0 - *
Definition
The sequence number of the sub-details woithin the details within the claim item which this line is intended to replace.
Comment
Requirements
Provides references to the claim sub-details within the claim detail.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.traceNumber
Id
ExplanationOfBenefit.addItem.traceNumber
Type
Cardinality
0 - *
Definition
Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.
Comment
Requirements
Allows partners to uniquely identify components for tracking.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.traceNumber.Identifier.use
Id
Identifier.use
Type
Cardinality
0 - 1
Definition
The purpose of this identifier.
Comment
Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Requirements
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Binding
Strength
required
Description
Identifies the purpose for this identifier, if known .
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.traceNumber.Identifier.type
Id
Identifier.type
Type
Cardinality
0 - 1
Definition
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Comment
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.
Requirements
Allows users to make use of identifiers when the identifier system is not known.
Binding
Strength
extensible
Description
A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.traceNumber.Identifier.type.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.traceNumber.Identifier.system
Id
Identifier.system
Type
Cardinality
0 - 1
Definition
Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.
Comment
Identifier.system is always case sensitive.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.traceNumber.Identifier.value
Id
Identifier.value
Type
Cardinality
0 - 1
Definition
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comment
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 [http://hl7.org/fhir/StructureDefinition/rendered-value](http://hl7.org/fhir/extensions/StructureDefinition-rendered-value.html)). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ident-1
Path
ExplanationOfBenefit.addItem.traceNumber.Identifier.period
Id
Identifier.period
Type
Cardinality
0 - 1
Definition
Time period during which identifier is/was valid for use.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.traceNumber.Identifier.period.Period.start
Id
Period.start
Type
Cardinality
0 - 1
Definition
The start of the period. The boundary is inclusive.
Comment
If the low element is missing, the meaning is that the low boundary is not known.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
ExplanationOfBenefit.addItem.traceNumber.Identifier.period.Period.end
Id
Period.end
Type
Cardinality
0 - 1
Definition
The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. 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.
Comment
The end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
ExplanationOfBenefit.addItem.traceNumber.Identifier.assigner
Id
Identifier.assigner
Type
Cardinality
0 - 1
Definition
Organization that issued/manages the identifier.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.traceNumber.Identifier.assigner.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
ref-1
Path
ExplanationOfBenefit.addItem.traceNumber.Identifier.assigner.Reference.type
Id
Reference.type
Type
Cardinality
0 - 1
Definition
The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comment
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.
Binding
Strength
extensible
Description
Aa resource (or, for logical models, the URI of the logical model).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.traceNumber.Identifier.assigner.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.
Comment
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.
Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.addItem.traceNumber.Identifier.assigner.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.addItem.provider
Id
ExplanationOfBenefit.addItem.provider
Type
Cardinality
0 - *
Definition
The providers who are authorized for the services rendered to the patient.
Comment
Requirements
Insurer may provide authorization specifically to a restricted set of providers rather than an open authorization.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.provider.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
ref-1
Path
ExplanationOfBenefit.addItem.provider.Reference.type
Id
Reference.type
Type
Cardinality
0 - 1
Definition
The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comment
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.
Binding
Strength
extensible
Description
Aa resource (or, for logical models, the URI of the logical model).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.provider.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.
Comment
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.
Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.addItem.provider.Reference.identifier.Identifier.use
Id
Identifier.use
Type
Cardinality
0 - 1
Definition
The purpose of this identifier.
Comment
Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Requirements
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Binding
Strength
required
Description
Identifies the purpose for this identifier, if known .
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.provider.Reference.identifier.Identifier.type
Id
Identifier.type
Type
Cardinality
0 - 1
Definition
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Comment
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.
Requirements
Allows users to make use of identifiers when the identifier system is not known.
Binding
Strength
extensible
Description
A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.provider.Reference.identifier.Identifier.system
Id
Identifier.system
Type
Cardinality
0 - 1
Definition
Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.
Comment
Identifier.system is always case sensitive.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.provider.Reference.identifier.Identifier.value
Id
Identifier.value
Type
Cardinality
0 - 1
Definition
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comment
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 [http://hl7.org/fhir/StructureDefinition/rendered-value](http://hl7.org/fhir/extensions/StructureDefinition-rendered-value.html)). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ident-1
Path
ExplanationOfBenefit.addItem.provider.Reference.identifier.Identifier.period
Id
Identifier.period
Type
Cardinality
0 - 1
Definition
Time period during which identifier is/was valid for use.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.provider.Reference.identifier.Identifier.assigner
Id
Identifier.assigner
Type
Cardinality
0 - 1
Definition
Organization that issued/manages the identifier.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.provider.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.addItem.revenue
Id
ExplanationOfBenefit.addItem.revenue
Type
Cardinality
0 - 1
Definition
The type of revenue or cost center providing the product and/or service.
Comment
Requirements
Needed in the processing of institutional claims.
Binding
Strength
example
Description
Codes for the revenue or cost centers supplying the service and/or products.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.revenue.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.revenue.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
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 be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.revenue.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.revenue.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
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).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.addItem.revenue.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.addItem.revenue.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
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.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.productOrService
Id
ExplanationOfBenefit.addItem.productOrService
Type
Cardinality
0 - 1
Definition
When the value is a group code then this item collects a set of related item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used.
Comment
If this is an actual service or product line, i.e. not a Group, then use code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS, USCLS, ICD10, NCPDP, DIN, RxNorm, ACHI, CCI). If a grouping item then use a group code to indicate the type of thing being grouped e.g. 'glasses' or 'compound'.
Requirements
Necessary to state what was provided or done.
Binding
Strength
example
Description
Allowable service and product codes.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.productOrService.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.productOrService.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
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 be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.productOrService.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.productOrService.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
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).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.addItem.productOrService.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.addItem.productOrService.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
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.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.productOrServiceEnd
Id
ExplanationOfBenefit.addItem.productOrServiceEnd
Type
Cardinality
0 - 1
Definition
This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.productOrServiceEnd.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.productOrServiceEnd.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
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 be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.productOrServiceEnd.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.productOrServiceEnd.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
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).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.addItem.productOrServiceEnd.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.addItem.productOrServiceEnd.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
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.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.request
Id
ExplanationOfBenefit.addItem.request
Type
Cardinality
0 - *
Definition
Request or Referral for Goods or Service to be rendered.
Comment
Requirements
May identify the service to be provided or provider authorization for the service.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.request.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
ref-1
Path
ExplanationOfBenefit.addItem.request.Reference.type
Id
Reference.type
Type
Cardinality
0 - 1
Definition
The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comment
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.
Binding
Strength
extensible
Description
Aa resource (or, for logical models, the URI of the logical model).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.request.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.
Comment
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.
Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.addItem.request.Reference.identifier.Identifier.use
Id
Identifier.use
Type
Cardinality
0 - 1
Definition
The purpose of this identifier.
Comment
Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Requirements
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Binding
Strength
required
Description
Identifies the purpose for this identifier, if known .
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.request.Reference.identifier.Identifier.type
Id
Identifier.type
Type
Cardinality
0 - 1
Definition
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Comment
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.
Requirements
Allows users to make use of identifiers when the identifier system is not known.
Binding
Strength
extensible
Description
A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.request.Reference.identifier.Identifier.system
Id
Identifier.system
Type
Cardinality
0 - 1
Definition
Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.
Comment
Identifier.system is always case sensitive.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.request.Reference.identifier.Identifier.value
Id
Identifier.value
Type
Cardinality
0 - 1
Definition
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comment
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 [http://hl7.org/fhir/StructureDefinition/rendered-value](http://hl7.org/fhir/extensions/StructureDefinition-rendered-value.html)). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ident-1
Path
ExplanationOfBenefit.addItem.request.Reference.identifier.Identifier.period
Id
Identifier.period
Type
Cardinality
0 - 1
Definition
Time period during which identifier is/was valid for use.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.request.Reference.identifier.Identifier.assigner
Id
Identifier.assigner
Type
Cardinality
0 - 1
Definition
Organization that issued/manages the identifier.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.request.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.addItem.modifier
Id
ExplanationOfBenefit.addItem.modifier
Type
Cardinality
0 - *
Definition
Item typification or modifiers codes to convey additional context for the product or service.
Comment
For example, in 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.
Requirements
To support inclusion of the item for adjudication or to charge an elevated fee.
Binding
Strength
example
Description
Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.modifier.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.modifier.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
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 be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.modifier.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.modifier.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
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).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.addItem.modifier.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.addItem.modifier.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
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.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.programCode
Id
ExplanationOfBenefit.addItem.programCode
Type
Cardinality
0 - *
Definition
Identifies the program under which this may be recovered.
Comment
For example: Neonatal program, child dental program or drug users recovery program.
Requirements
Commonly used in in the identification of publicly provided program focused on population segments or disease classifications.
Binding
Strength
example
Description
Program specific reason codes.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.programCode.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.programCode.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
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 be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.programCode.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.programCode.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
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).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.addItem.programCode.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.addItem.programCode.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
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.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.serviced[x]
Id
ExplanationOfBenefit.addItem.serviced[x]
Type
Cardinality
0 - 1
Definition
The date or dates when the service or product was supplied, performed or completed.
Comment
Requirements
Needed to determine whether the service or product was provided during the term of the insurance coverage.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.location[x]
Id
ExplanationOfBenefit.addItem.location[x]
Type
Cardinality
0 - 1
Definition
Where the product or service was provided.
Comment
Requirements
The location can alter whether the item was acceptable for insurance purposes or impact the determination of the benefit amount.
Binding
Strength
example
Description
Place where the service is rendered.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.location[x].CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.location[x].CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
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 be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.location[x].CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.location[x].CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
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).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.addItem.location[x].CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.addItem.location[x].CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
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.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.patientPaid
Id
ExplanationOfBenefit.addItem.patientPaid
Type
Cardinality
0 - 1
Definition
The amount paid by the patient, in total at the claim claim level or specifically for the item and detail level, to the provider for goods and services.
Comment
Requirements
Necessary to demonstrate that copayments, co-insurance and similar patient payments have been made or accounted for.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.patientPaid.Money.value
Id
Money.value
Type
Cardinality
0 - 1
Definition
Numerical value (with implicit precision).
Comment
Monetary values have their own rules for handling precision (refer to standard accounting text books).
Requirements
The amount of the currency. The value includes an implicit precision in the presentation of the value.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.patientPaid.Money.currency
Id
Money.currency
Type
Cardinality
0 - 1
Definition
ISO 4217 Currency Code.
Comment
Requirements
A code indicating the currency, taken from ISO 4217.
Binding
Strength
required
Description
A code indicating the currency, taken from ISO 4217.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.quantity
Id
ExplanationOfBenefit.addItem.quantity
Type
Cardinality
0 - 1
Definition
The number of repetitions of a service or product.
Comment
Requirements
Required when the product or service code does not convey the quantity provided.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.quantity.Quantity.value
Id
Quantity.value
Type
Cardinality
0 - 1
Definition
The value of the measured amount. The value includes an implicit precision in the presentation of the value.
Comment
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).
Requirements
Precision is handled implicitly in almost all cases of measurement.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.quantity.Quantity.comparator
Id
Quantity.comparator
Type
Cardinality
0 - 1
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.
Comment
Requirements
Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.
Binding
Strength
required
Description
How the Quantity should be understood and represented.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.quantity.Quantity.unit
Id
Quantity.unit
Type
Cardinality
0 - 1
Definition
A human-readable form of the unit.
Comment
Requirements
There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.quantity.Quantity.system
Id
Quantity.system
Type
Cardinality
0 - 1
Definition
The identification of the system that provides the coded form of the unit.
Comment
Requirements
Need to know the system that defines the coded form of the unit.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
qty-3
Path
ExplanationOfBenefit.addItem.quantity.Quantity.code
Id
Quantity.code
Type
Cardinality
0 - 1
Definition
A computer processable form of the unit in some unit representation system.
Comment
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.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
qty-3
Path
ExplanationOfBenefit.addItem.unitPrice
Id
ExplanationOfBenefit.addItem.unitPrice
Type
Cardinality
0 - 1
Definition
If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.
Comment
Requirements
The amount charged to the patient by the provider for a single unit.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.unitPrice.Money.value
Id
Money.value
Type
Cardinality
0 - 1
Definition
Numerical value (with implicit precision).
Comment
Monetary values have their own rules for handling precision (refer to standard accounting text books).
Requirements
The amount of the currency. The value includes an implicit precision in the presentation of the value.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.unitPrice.Money.currency
Id
Money.currency
Type
Cardinality
0 - 1
Definition
ISO 4217 Currency Code.
Comment
Requirements
A code indicating the currency, taken from ISO 4217.
Binding
Strength
required
Description
A code indicating the currency, taken from ISO 4217.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.factor
Id
ExplanationOfBenefit.addItem.factor
Type
Cardinality
0 - 1
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.
Comment
To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10).
Requirements
When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.tax
Id
ExplanationOfBenefit.addItem.tax
Type
Cardinality
0 - 1
Definition
The total of taxes applicable for this product or service.
Comment
Requirements
Required when taxes are not embedded in the unit price or provided as a separate service.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.tax.Money.value
Id
Money.value
Type
Cardinality
0 - 1
Definition
Numerical value (with implicit precision).
Comment
Monetary values have their own rules for handling precision (refer to standard accounting text books).
Requirements
The amount of the currency. The value includes an implicit precision in the presentation of the value.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.tax.Money.currency
Id
Money.currency
Type
Cardinality
0 - 1
Definition
ISO 4217 Currency Code.
Comment
Requirements
A code indicating the currency, taken from ISO 4217.
Binding
Strength
required
Description
A code indicating the currency, taken from ISO 4217.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.net
Id
ExplanationOfBenefit.addItem.net
Type
Cardinality
0 - 1
Definition
The total amount claimed for the group (if a grouper) or the addItem. Net = unit price * quantity * factor.
Comment
For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.
Requirements
Provides the total amount claimed for the group (if a grouper) or the line item.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.net.Money.value
Id
Money.value
Type
Cardinality
0 - 1
Definition
Numerical value (with implicit precision).
Comment
Monetary values have their own rules for handling precision (refer to standard accounting text books).
Requirements
The amount of the currency. The value includes an implicit precision in the presentation of the value.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.net.Money.currency
Id
Money.currency
Type
Cardinality
0 - 1
Definition
ISO 4217 Currency Code.
Comment
Requirements
A code indicating the currency, taken from ISO 4217.
Binding
Strength
required
Description
A code indicating the currency, taken from ISO 4217.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.bodySite
Id
ExplanationOfBenefit.addItem.bodySite
Type
Cardinality
0 - *
Definition
Physical location where the service is performed or applies.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.bodySite.site
Id
ExplanationOfBenefit.addItem.bodySite.site
Type
Cardinality
1 - *
Definition
Physical service site on the patient (limb, tooth, etc.).
Comment
For example, providing a tooth code allows an insurer to identify a provider performing a filling on a tooth that was previously removed.
Requirements
Allows insurer to validate specific procedures.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.bodySite.site.CodeableReference.concept
Id
CodeableReference.concept
Type
Cardinality
0 - 1
Definition
A reference to a concept - e.g. the information is identified by its general class to the degree of precision found in the terminology.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.bodySite.site.CodeableReference.reference
Id
CodeableReference.reference
Type
Cardinality
0 - 1
Definition
A reference to a resource the provides exact details about the information being referenced.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.bodySite.subSite
Id
ExplanationOfBenefit.addItem.bodySite.subSite
Type
Cardinality
0 - *
Definition
A region or surface of the bodySite, e.g. limb region or tooth surface(s).
Comment
Requirements
Allows insurer to validate specific procedures.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.bodySite.subSite.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.noteNumber
Id
ExplanationOfBenefit.addItem.noteNumber
Type
Cardinality
0 - *
Definition
The numbers associated with notes below which apply to the adjudication of this item.
Comment
Requirements
Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.reviewOutcome
Id
ExplanationOfBenefit.addItem.reviewOutcome
Type
Cardinality
0 - 1
Definition
The high-level results of the adjudication if adjudication has been performed.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.adjudication
Id
ExplanationOfBenefit.addItem.adjudication
Type
Cardinality
0 - *
Definition
The adjudication results.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.detail
Id
ExplanationOfBenefit.addItem.detail
Type
Cardinality
0 - *
Definition
The second-tier service adjudications for payor added services.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.detail.traceNumber
Id
ExplanationOfBenefit.addItem.detail.traceNumber
Type
Cardinality
0 - *
Definition
Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.
Comment
Requirements
Allows partners to uniquely identify components for tracking.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.detail.traceNumber.Identifier.use
Id
Identifier.use
Type
Cardinality
0 - 1
Definition
The purpose of this identifier.
Comment
Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Requirements
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Binding
Strength
required
Description
Identifies the purpose for this identifier, if known .
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.detail.traceNumber.Identifier.type
Id
Identifier.type
Type
Cardinality
0 - 1
Definition
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Comment
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.
Requirements
Allows users to make use of identifiers when the identifier system is not known.
Binding
Strength
extensible
Description
A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.detail.traceNumber.Identifier.system
Id
Identifier.system
Type
Cardinality
0 - 1
Definition
Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.
Comment
Identifier.system is always case sensitive.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.detail.traceNumber.Identifier.value
Id
Identifier.value
Type
Cardinality
0 - 1
Definition
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comment
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 [http://hl7.org/fhir/StructureDefinition/rendered-value](http://hl7.org/fhir/extensions/StructureDefinition-rendered-value.html)). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ident-1
Path
ExplanationOfBenefit.addItem.detail.traceNumber.Identifier.period
Id
Identifier.period
Type
Cardinality
0 - 1
Definition
Time period during which identifier is/was valid for use.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.detail.traceNumber.Identifier.assigner
Id
Identifier.assigner
Type
Cardinality
0 - 1
Definition
Organization that issued/manages the identifier.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.detail.revenue
Id
ExplanationOfBenefit.addItem.detail.revenue
Type
Cardinality
0 - 1
Definition
The type of revenue or cost center providing the product and/or service.
Comment
Requirements
Needed in the processing of institutional claims.
Binding
Strength
example
Description
Codes for the revenue or cost centers supplying the service and/or products.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.detail.revenue.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.detail.productOrService
Id
ExplanationOfBenefit.addItem.detail.productOrService
Type
Cardinality
0 - 1
Definition
When the value is a group code then this item collects a set of related item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used.
Comment
If this is an actual service or product line, i.e. not a Group, then use code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS, USCLS, ICD10, NCPDP, DIN, RxNorm, ACHI, CCI). If a grouping item then use a group code to indicate the type of thing being grouped e.g. 'glasses' or 'compound'.
Requirements
Necessary to state what was provided or done.
Binding
Strength
example
Description
Allowable service and product codes.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.detail.productOrService.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.detail.productOrServiceEnd
Id
ExplanationOfBenefit.addItem.detail.productOrServiceEnd
Type
Cardinality
0 - 1
Definition
This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.detail.productOrServiceEnd.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.detail.modifier
Id
ExplanationOfBenefit.addItem.detail.modifier
Type
Cardinality
0 - *
Definition
Item typification or modifiers codes to convey additional context for the product or service.
Comment
For example, in 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.
Requirements
To support inclusion of the item for adjudication or to charge an elevated fee.
Binding
Strength
example
Description
Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.detail.modifier.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.detail.patientPaid
Id
ExplanationOfBenefit.addItem.detail.patientPaid
Type
Cardinality
0 - 1
Definition
The amount paid by the patient, in total at the claim claim level or specifically for the item and detail level, to the provider for goods and services.
Comment
Requirements
Necessary to demonstrate that copayments, co-insurance and similar patient payments have been made or accounted for.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.detail.patientPaid.Money.value
Id
Money.value
Type
Cardinality
0 - 1
Definition
Numerical value (with implicit precision).
Comment
Monetary values have their own rules for handling precision (refer to standard accounting text books).
Requirements
The amount of the currency. The value includes an implicit precision in the presentation of the value.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.detail.patientPaid.Money.currency
Id
Money.currency
Type
Cardinality
0 - 1
Definition
ISO 4217 Currency Code.
Comment
Requirements
A code indicating the currency, taken from ISO 4217.
Binding
Strength
required
Description
A code indicating the currency, taken from ISO 4217.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.detail.quantity
Id
ExplanationOfBenefit.addItem.detail.quantity
Type
Cardinality
0 - 1
Definition
The number of repetitions of a service or product.
Comment
Requirements
Required when the product or service code does not convey the quantity provided.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.detail.quantity.Quantity.value
Id
Quantity.value
Type
Cardinality
0 - 1
Definition
The value of the measured amount. The value includes an implicit precision in the presentation of the value.
Comment
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).
Requirements
Precision is handled implicitly in almost all cases of measurement.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.detail.quantity.Quantity.comparator
Id
Quantity.comparator
Type
Cardinality
0 - 1
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.
Comment
Requirements
Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.
Binding
Strength
required
Description
How the Quantity should be understood and represented.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.detail.quantity.Quantity.unit
Id
Quantity.unit
Type
Cardinality
0 - 1
Definition
A human-readable form of the unit.
Comment
Requirements
There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.detail.quantity.Quantity.system
Id
Quantity.system
Type
Cardinality
0 - 1
Definition
The identification of the system that provides the coded form of the unit.
Comment
Requirements
Need to know the system that defines the coded form of the unit.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
qty-3
Path
ExplanationOfBenefit.addItem.detail.quantity.Quantity.code
Id
Quantity.code
Type
Cardinality
0 - 1
Definition
A computer processable form of the unit in some unit representation system.
Comment
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.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
qty-3
Path
ExplanationOfBenefit.addItem.detail.unitPrice
Id
ExplanationOfBenefit.addItem.detail.unitPrice
Type
Cardinality
0 - 1
Definition
If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.
Comment
Requirements
The amount charged to the patient by the provider for a single unit.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.detail.unitPrice.Money.value
Id
Money.value
Type
Cardinality
0 - 1
Definition
Numerical value (with implicit precision).
Comment
Monetary values have their own rules for handling precision (refer to standard accounting text books).
Requirements
The amount of the currency. The value includes an implicit precision in the presentation of the value.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.detail.unitPrice.Money.currency
Id
Money.currency
Type
Cardinality
0 - 1
Definition
ISO 4217 Currency Code.
Comment
Requirements
A code indicating the currency, taken from ISO 4217.
Binding
Strength
required
Description
A code indicating the currency, taken from ISO 4217.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.detail.factor
Id
ExplanationOfBenefit.addItem.detail.factor
Type
Cardinality
0 - 1
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.
Comment
To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10).
Requirements
When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.detail.tax
Id
ExplanationOfBenefit.addItem.detail.tax
Type
Cardinality
0 - 1
Definition
The total of taxes applicable for this product or service.
Comment
Requirements
Required when taxes are not embedded in the unit price or provided as a separate service.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.detail.tax.Money.value
Id
Money.value
Type
Cardinality
0 - 1
Definition
Numerical value (with implicit precision).
Comment
Monetary values have their own rules for handling precision (refer to standard accounting text books).
Requirements
The amount of the currency. The value includes an implicit precision in the presentation of the value.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.detail.tax.Money.currency
Id
Money.currency
Type
Cardinality
0 - 1
Definition
ISO 4217 Currency Code.
Comment
Requirements
A code indicating the currency, taken from ISO 4217.
Binding
Strength
required
Description
A code indicating the currency, taken from ISO 4217.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.detail.net
Id
ExplanationOfBenefit.addItem.detail.net
Type
Cardinality
0 - 1
Definition
The total amount claimed for the group (if a grouper) or the addItem.detail. Net = unit price * quantity * factor.
Comment
For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.
Requirements
Provides the total amount claimed for the group (if a grouper) or the line item.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.detail.net.Money.value
Id
Money.value
Type
Cardinality
0 - 1
Definition
Numerical value (with implicit precision).
Comment
Monetary values have their own rules for handling precision (refer to standard accounting text books).
Requirements
The amount of the currency. The value includes an implicit precision in the presentation of the value.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.detail.net.Money.currency
Id
Money.currency
Type
Cardinality
0 - 1
Definition
ISO 4217 Currency Code.
Comment
Requirements
A code indicating the currency, taken from ISO 4217.
Binding
Strength
required
Description
A code indicating the currency, taken from ISO 4217.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.detail.noteNumber
Id
ExplanationOfBenefit.addItem.detail.noteNumber
Type
Cardinality
0 - *
Definition
The numbers associated with notes below which apply to the adjudication of this item.
Comment
Requirements
Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
reviewOutcome
Additem detail level adjudication results
Path
ExplanationOfBenefit.addItem.detail.reviewOutcome
Id
ExplanationOfBenefit.addItem.detail.reviewOutcome
Type
Cardinality
0 - 1
Definition
The high-level results of the adjudication if adjudication has been performed.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.detail.adjudication
Id
ExplanationOfBenefit.addItem.detail.adjudication
Type
Cardinality
0 - *
Definition
The adjudication results.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.detail.subDetail
Id
ExplanationOfBenefit.addItem.detail.subDetail
Type
Cardinality
0 - *
Definition
The third-tier service adjudications for payor added services.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.detail.subDetail.traceNumber
Id
ExplanationOfBenefit.addItem.detail.subDetail.traceNumber
Type
Cardinality
0 - *
Definition
Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.
Comment
Requirements
Allows partners to uniquely identify components for tracking.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.detail.subDetail.revenue
Id
ExplanationOfBenefit.addItem.detail.subDetail.revenue
Type
Cardinality
0 - 1
Definition
The type of revenue or cost center providing the product and/or service.
Comment
Requirements
Needed in the processing of institutional claims.
Binding
Strength
example
Description
Codes for the revenue or cost centers supplying the service and/or products.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.detail.subDetail.productOrService
Id
ExplanationOfBenefit.addItem.detail.subDetail.productOrService
Type
Cardinality
0 - 1
Definition
When the value is a group code then this item collects a set of related item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used.
Comment
If this is an actual service or product line, i.e. not a Group, then use code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS, USCLS, ICD10, NCPDP, DIN, RxNorm, ACHI, CCI). If a grouping item then use a group code to indicate the type of thing being grouped e.g. 'glasses' or 'compound'.
Requirements
Necessary to state what was provided or done.
Binding
Strength
example
Description
Allowable service and product codes.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.detail.subDetail.productOrServiceEnd
Id
ExplanationOfBenefit.addItem.detail.subDetail.productOrServiceEnd
Type
Cardinality
0 - 1
Definition
This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.detail.subDetail.modifier
Id
ExplanationOfBenefit.addItem.detail.subDetail.modifier
Type
Cardinality
0 - *
Definition
Item typification or modifiers codes to convey additional context for the product or service.
Comment
For example, in 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.
Requirements
To support inclusion of the item for adjudication or to charge an elevated fee.
Binding
Strength
example
Description
Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.detail.subDetail.patientPaid
Id
ExplanationOfBenefit.addItem.detail.subDetail.patientPaid
Type
Cardinality
0 - 1
Definition
The amount paid by the patient, in total at the claim claim level or specifically for the item and detail level, to the provider for goods and services.
Comment
Requirements
Necessary to demonstrate that copayments, co-insurance and similar patient payments have been made or accounted for.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.detail.subDetail.quantity
Id
ExplanationOfBenefit.addItem.detail.subDetail.quantity
Type
Cardinality
0 - 1
Definition
The number of repetitions of a service or product.
Comment
Requirements
Required when the product or service code does not convey the quantity provided.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.detail.subDetail.unitPrice
Id
ExplanationOfBenefit.addItem.detail.subDetail.unitPrice
Type
Cardinality
0 - 1
Definition
If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.
Comment
Requirements
The amount charged to the patient by the provider for a single unit.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.detail.subDetail.factor
Id
ExplanationOfBenefit.addItem.detail.subDetail.factor
Type
Cardinality
0 - 1
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.
Comment
To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10).
Requirements
When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.detail.subDetail.tax
Id
ExplanationOfBenefit.addItem.detail.subDetail.tax
Type
Cardinality
0 - 1
Definition
The total of taxes applicable for this product or service.
Comment
Requirements
Required when taxes are not embedded in the unit price or provided as a separate service.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.detail.subDetail.net
Id
ExplanationOfBenefit.addItem.detail.subDetail.net
Type
Cardinality
0 - 1
Definition
The total amount claimed for the addItem.detail.subDetail. Net = unit price * quantity * factor.
Comment
For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.
Requirements
Provides the total amount claimed for the group (if a grouper) or the line item.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.detail.subDetail.noteNumber
Id
ExplanationOfBenefit.addItem.detail.subDetail.noteNumber
Type
Cardinality
0 - *
Definition
The numbers associated with notes below which apply to the adjudication of this item.
Comment
Requirements
Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
reviewOutcome
Additem subdetail level adjudication results
Path
ExplanationOfBenefit.addItem.detail.subDetail.reviewOutcome
Id
ExplanationOfBenefit.addItem.detail.subDetail.reviewOutcome
Type
Cardinality
0 - 1
Definition
The high-level results of the adjudication if adjudication has been performed.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.addItem.detail.subDetail.adjudication
Id
ExplanationOfBenefit.addItem.detail.subDetail.adjudication
Type
Cardinality
0 - *
Definition
The adjudication results.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.adjudication
Id
ExplanationOfBenefit.adjudication
Type
Cardinality
0 - *
Definition
The adjudication results which are presented at the header level rather than at the line-item or add-item levels.
Comment
Requirements
Some insurers will receive line-items but provide the adjudication only at a summary or header-level.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.total
Id
ExplanationOfBenefit.total
Type
Cardinality
0 - *
Definition
Categorized monetary totals for the adjudication.
Comment
Totals for amounts submitted, co-pays, benefits payable etc.
Requirements
To provide the requestor with financial totals by category for the adjudication.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.total.category
Id
ExplanationOfBenefit.total.category
Type
Cardinality
1 - 1
Definition
A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item.
Comment
For example, codes indicating: Co-Pay, deductible, eligible, benefit, tax, etc.
Requirements
Needed to convey the type of total provided.
Binding
Strength
example
Description
The adjudication codes.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.total.category.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.total.category.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
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 be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.total.category.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.total.category.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
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).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.total.category.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.total.category.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
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.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.total.amount
Id
ExplanationOfBenefit.total.amount
Type
Cardinality
1 - 1
Definition
Monetary total amount associated with the category.
Comment
Requirements
Needed to convey the total monetary amount.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.total.amount.Money.value
Id
Money.value
Type
Cardinality
0 - 1
Definition
Numerical value (with implicit precision).
Comment
Monetary values have their own rules for handling precision (refer to standard accounting text books).
Requirements
The amount of the currency. The value includes an implicit precision in the presentation of the value.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.total.amount.Money.currency
Id
Money.currency
Type
Cardinality
0 - 1
Definition
ISO 4217 Currency Code.
Comment
Requirements
A code indicating the currency, taken from ISO 4217.
Binding
Strength
required
Description
A code indicating the currency, taken from ISO 4217.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.payment
Id
ExplanationOfBenefit.payment
Type
Cardinality
0 - 1
Definition
Payment details for the adjudication of the claim.
Comment
Requirements
Needed to convey references to the financial instrument that has been used if payment has been made.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.payment.type
Id
ExplanationOfBenefit.payment.type
Type
Cardinality
0 - 1
Definition
Whether this represents partial or complete payment of the benefits payable.
Comment
Requirements
To advise the requestor when the insurer believes all payments to have been completed.
Binding
Strength
example
Description
The type (partial, complete) of the payment.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.payment.type.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.payment.type.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
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 be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.payment.type.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.payment.type.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
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).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.payment.type.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.payment.type.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
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.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.payment.adjustment
Id
ExplanationOfBenefit.payment.adjustment
Type
Cardinality
0 - 1
Definition
Total amount of all adjustments to this payment included in this transaction which are not related to this claim's adjudication.
Comment
Insurers will deduct amounts owing from the provider (adjustment), such as a prior overpayment, from the amount owing to the provider (benefits payable) when payment is made to the provider.
Requirements
To advise the requestor of adjustments applied to the payment.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.payment.adjustment.Money.value
Id
Money.value
Type
Cardinality
0 - 1
Definition
Numerical value (with implicit precision).
Comment
Monetary values have their own rules for handling precision (refer to standard accounting text books).
Requirements
The amount of the currency. The value includes an implicit precision in the presentation of the value.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.payment.adjustment.Money.currency
Id
Money.currency
Type
Cardinality
0 - 1
Definition
ISO 4217 Currency Code.
Comment
Requirements
A code indicating the currency, taken from ISO 4217.
Binding
Strength
required
Description
A code indicating the currency, taken from ISO 4217.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.payment.adjustmentReason
Id
ExplanationOfBenefit.payment.adjustmentReason
Type
Cardinality
0 - 1
Definition
Reason for the payment adjustment.
Comment
Requirements
Needed to clarify the monetary adjustment.
Binding
Strength
example
Description
Payment Adjustment reason codes.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.payment.adjustmentReason.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.payment.adjustmentReason.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
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 be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.payment.adjustmentReason.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.payment.adjustmentReason.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
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).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.payment.adjustmentReason.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.payment.adjustmentReason.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
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.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.payment.date
Id
ExplanationOfBenefit.payment.date
Type
Cardinality
0 - 1
Definition
Estimated date the payment will be issued or the actual issue date of payment.
Comment
Requirements
To advise the payee when payment can be expected.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.payment.amount
Id
ExplanationOfBenefit.payment.amount
Type
Cardinality
0 - 1
Definition
Benefits payable less any payment adjustment.
Comment
Requirements
Needed to provide the actual payment amount.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.payment.amount.Money.value
Id
Money.value
Type
Cardinality
0 - 1
Definition
Numerical value (with implicit precision).
Comment
Monetary values have their own rules for handling precision (refer to standard accounting text books).
Requirements
The amount of the currency. The value includes an implicit precision in the presentation of the value.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.payment.amount.Money.currency
Id
Money.currency
Type
Cardinality
0 - 1
Definition
ISO 4217 Currency Code.
Comment
Requirements
A code indicating the currency, taken from ISO 4217.
Binding
Strength
required
Description
A code indicating the currency, taken from ISO 4217.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.payment.identifier
Id
ExplanationOfBenefit.payment.identifier
Type
Cardinality
0 - 1
Definition
Issuer's unique identifier for the payment instrument.
Comment
For example: EFT number or check number.
Requirements
Enable the receiver to reconcile when payment received.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.payment.identifier.Identifier.use
Id
Identifier.use
Type
Cardinality
0 - 1
Definition
The purpose of this identifier.
Comment
Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Requirements
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Binding
Strength
required
Description
Identifies the purpose for this identifier, if known .
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.payment.identifier.Identifier.type
Id
Identifier.type
Type
Cardinality
0 - 1
Definition
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Comment
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.
Requirements
Allows users to make use of identifiers when the identifier system is not known.
Binding
Strength
extensible
Description
A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.payment.identifier.Identifier.type.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.payment.identifier.Identifier.system
Id
Identifier.system
Type
Cardinality
0 - 1
Definition
Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.
Comment
Identifier.system is always case sensitive.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.payment.identifier.Identifier.value
Id
Identifier.value
Type
Cardinality
0 - 1
Definition
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comment
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 [http://hl7.org/fhir/StructureDefinition/rendered-value](http://hl7.org/fhir/extensions/StructureDefinition-rendered-value.html)). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ident-1
Path
ExplanationOfBenefit.payment.identifier.Identifier.period
Id
Identifier.period
Type
Cardinality
0 - 1
Definition
Time period during which identifier is/was valid for use.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.payment.identifier.Identifier.period.Period.start
Id
Period.start
Type
Cardinality
0 - 1
Definition
The start of the period. The boundary is inclusive.
Comment
If the low element is missing, the meaning is that the low boundary is not known.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
ExplanationOfBenefit.payment.identifier.Identifier.period.Period.end
Id
Period.end
Type
Cardinality
0 - 1
Definition
The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. 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.
Comment
The end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
ExplanationOfBenefit.payment.identifier.Identifier.assigner
Id
Identifier.assigner
Type
Cardinality
0 - 1
Definition
Organization that issued/manages the identifier.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.payment.identifier.Identifier.assigner.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
ref-1
Path
ExplanationOfBenefit.payment.identifier.Identifier.assigner.Reference.type
Id
Reference.type
Type
Cardinality
0 - 1
Definition
The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comment
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.
Binding
Strength
extensible
Description
Aa resource (or, for logical models, the URI of the logical model).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.payment.identifier.Identifier.assigner.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.
Comment
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.
Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.payment.identifier.Identifier.assigner.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExplanationOfBenefit.formCode
Id
ExplanationOfBenefit.formCode
Type
Cardinality
0 - 1
Definition
A code for the form to be used for printing the content.
Comment
May be needed to identify specific jurisdictional forms.
Requirements
Needed to specify the specific form used for producing output for this response.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.formCode.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.formCode.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
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 be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.formCode.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.formCode.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
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).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.formCode.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.formCode.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
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.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.form
Id
ExplanationOfBenefit.form
Type
Cardinality
0 - 1
Definition
The actual form, by reference or inclusion, for printing the content or an EOB.
Comment
Needed to permit insurers to include the actual form.
Requirements
Needed to include the specific form used for producing output for this response.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.form.Attachment.contentType
Id
Attachment.contentType
Type
Cardinality
0 - 1
Definition
Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.
Comment
Requirements
Processors of the data need to be able to know how to interpret the data.
Binding
Strength
required
Description
BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
att-1
Path
ExplanationOfBenefit.form.Attachment.data
Id
Attachment.data
Type
Cardinality
0 - 1
Definition
The actual data of the attachment - a sequence of bytes, base64 encoded.
Comment
The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON.
Requirements
The data needs to able to be transmitted inline.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
att-1
Path
ExplanationOfBenefit.form.Attachment.url
Id
Attachment.url
Type
Cardinality
0 - 1
Definition
A location where the data can be accessed.
Comment
If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data.
Requirements
The data needs to be transmitted by reference.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.form.Attachment.size
Id
Attachment.size
Type
Cardinality
0 - 1
Definition
The number of bytes of data that make up this attachment (before base64 encoding, if that is done).
Comment
The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference.
Requirements
Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.form.Attachment.hash
Id
Attachment.hash
Type
Cardinality
0 - 1
Definition
The calculated hash of the data using SHA-1. Represented using base64.
Comment
The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. The hash is not intended to support digital signatures. Where protection against malicious threats a digital signature should be considered, see [Provenance.signature](provenance-definitions.html#Provenance.signature) for mechanism to protect a resource with a digital signature.
Requirements
Included so that applications can verify that the contents of a location have not changed due to technical failures (e.g., storage rot, transport glitch, incorrect version).
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.form.Attachment.title
Id
Attachment.title
Type
Cardinality
0 - 1
Definition
A label or set of text to display in place of the data.
Comment
May sometimes be derived from the source filename.
Requirements
Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.form.Attachment.creation
Id
Attachment.creation
Type
Cardinality
0 - 1
Definition
The date that the attachment was first created.
Comment
Requirements
This is often tracked as an integrity issue for use of the attachment.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.form.Attachment.height
Id
Attachment.height
Type
Cardinality
0 - 1
Definition
Height of the image in pixels (photo/video).
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.form.Attachment.width
Id
Attachment.width
Type
Cardinality
0 - 1
Definition
Width of the image in pixels (photo/video).
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.form.Attachment.frames
Id
Attachment.frames
Type
Cardinality
0 - 1
Definition
The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required.
Comment
if the number of frames is not supplied, the value may be unknown. Applications should not assume that there is only one frame unless it is explicitly stated.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.form.Attachment.duration
Id
Attachment.duration
Type
Cardinality
0 - 1
Definition
The duration of the recording in seconds - for audio and video.
Comment
The duration might differ from occurrencePeriod if recording was paused.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.form.Attachment.pages
Id
Attachment.pages
Type
Cardinality
0 - 1
Definition
The number of pages when printed.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.processNote
Id
ExplanationOfBenefit.processNote
Type
Cardinality
0 - *
Definition
A note that describes or explains adjudication results in a human readable form.
Comment
Requirements
Provides the insurer specific textual explanations associated with the processing.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.processNote.number
Id
ExplanationOfBenefit.processNote.number
Type
Cardinality
0 - 1
Definition
A number to uniquely identify a note entry.
Comment
Requirements
Necessary to provide a mechanism to link from adjudications.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.processNote.type
Id
ExplanationOfBenefit.processNote.type
Type
Cardinality
0 - 1
Definition
The business purpose of the note text.
Comment
Requirements
To convey the expectation for when the text is used.
Binding
Strength
extensible
Description
The presentation types of notes.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.processNote.type.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.processNote.type.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
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 be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.processNote.type.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.processNote.type.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
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).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.processNote.type.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.processNote.type.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
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.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.benefitPeriod
Id
ExplanationOfBenefit.benefitPeriod
Type
Cardinality
0 - 1
Definition
The term of the benefits documented in this response.
Comment
Not applicable when use=claim.
Requirements
Needed as coverages may be multi-year while benefits tend to be annual therefore a separate expression of the benefit period is needed.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.benefitPeriod.Period.start
Id
Period.start
Type
Cardinality
0 - 1
Definition
The start of the period. The boundary is inclusive.
Comment
If the low element is missing, the meaning is that the low boundary is not known.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
ExplanationOfBenefit.benefitPeriod.Period.end
Id
Period.end
Type
Cardinality
0 - 1
Definition
The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. 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.
Comment
The end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
ExplanationOfBenefit.benefitBalance
Id
ExplanationOfBenefit.benefitBalance
Type
Cardinality
0 - *
Definition
Balance by Benefit Category.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.benefitBalance.category
Id
ExplanationOfBenefit.benefitBalance.category
Type
Cardinality
1 - 1
Definition
Code to identify the general type of benefits under which products and services are provided.
Comment
Examples include Medical Care, Periodontics, Renal Dialysis, Vision Coverage.
Requirements
Needed to convey the category of service or product for which eligibility is sought.
Binding
Strength
example
Description
Benefit categories such as: oral, medical, vision, oral-basic etc.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.benefitBalance.category.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.benefitBalance.category.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
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 be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.benefitBalance.category.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.benefitBalance.category.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
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).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.benefitBalance.category.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.benefitBalance.category.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
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.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.benefitBalance.excluded
Id
ExplanationOfBenefit.benefitBalance.excluded
Type
Cardinality
0 - 1
Definition
True if the indicated class of service is excluded from the plan, missing or False indicates the product or service is included in the coverage.
Comment
Requirements
Needed to identify items that are specifically excluded from the coverage.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.benefitBalance.name
Id
ExplanationOfBenefit.benefitBalance.name
Type
Cardinality
0 - 1
Definition
A short name or tag for the benefit.
Comment
For example: MED01, or DENT2.
Requirements
Required to align with other plan names.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.benefitBalance.description
Id
ExplanationOfBenefit.benefitBalance.description
Type
Cardinality
0 - 1
Definition
A richer description of the benefit or services covered.
Comment
For example, 'DENT2 covers 100% of basic, 50% of major but excludes Ortho, Implants and Cosmetic services'.
Requirements
Needed for human readable reference.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.benefitBalance.network
Id
ExplanationOfBenefit.benefitBalance.network
Type
Cardinality
0 - 1
Definition
Is a flag to indicate whether the benefits refer to in-network providers or out-of-network providers.
Comment
Requirements
Needed as in or out of network providers are treated differently under the coverage.
Binding
Strength
example
Description
Code to classify in or out of network services.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.benefitBalance.network.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.benefitBalance.network.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
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 be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.benefitBalance.network.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.benefitBalance.network.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
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).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.benefitBalance.network.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.benefitBalance.network.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
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.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.benefitBalance.unit
Id
ExplanationOfBenefit.benefitBalance.unit
Type
Cardinality
0 - 1
Definition
Indicates if the benefits apply to an individual or to the family.
Comment
Requirements
Needed for the understanding of the benefits.
Binding
Strength
example
Description
Unit covered/serviced - individual or family.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.benefitBalance.unit.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.benefitBalance.unit.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
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 be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.benefitBalance.unit.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.benefitBalance.unit.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
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).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.benefitBalance.unit.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.benefitBalance.unit.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
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.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.benefitBalance.term
Id
ExplanationOfBenefit.benefitBalance.term
Type
Cardinality
0 - 1
Definition
The term or period of the values such as 'maximum lifetime benefit' or 'maximum annual visits'.
Comment
Requirements
Needed for the understanding of the benefits.
Binding
Strength
example
Description
Coverage unit - annual, lifetime.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.benefitBalance.term.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.benefitBalance.term.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
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 be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.benefitBalance.term.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.benefitBalance.term.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
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).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.benefitBalance.term.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExplanationOfBenefit.benefitBalance.term.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
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.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.benefitBalance.financial
Id
ExplanationOfBenefit.benefitBalance.financial
Type
Cardinality
0 - *
Definition
Benefits Used to date.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.benefitBalance.financial.type
Id
ExplanationOfBenefit.benefitBalance.financial.type
Type
Cardinality
1 - 1
Definition
Classification of benefit being provided.
Comment
For example: deductible, visits, benefit amount.
Requirements
Needed to convey the nature of the benefit.
Binding
Strength
example
Description
Deductable, visits, co-pay, etc.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.benefitBalance.financial.type.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.benefitBalance.financial.allowed[x]
Id
ExplanationOfBenefit.benefitBalance.financial.allowed[x]
Type
Cardinality
0 - 1
Definition
The quantity of the benefit which is permitted under the coverage.
Comment
Requirements
Needed to convey the benefits offered under the coverage.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExplanationOfBenefit.benefitBalance.financial.used[x]
Id
ExplanationOfBenefit.benefitBalance.financial.used[x]
Type
Cardinality
0 - 1
Definition
The quantity of the benefit which have been consumed to date.
Comment
Requirements
Needed to convey the benefits consumed to date.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children