This profile sets minimum expectations for the [ExplanationOfBenefit] Hospice Claim resource to record, search and fetch basic demographics and other administrative information about an individual Hospice Claim. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the resource when using this profile.
Example Usage Scenarios:
The following are example usage scenarios for the Blue Button Hospice Claim profile:
The following data-elements are mandatory (i.e data MUST be present). These are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.
Each Hospice Claim must have:
If the data is available a Hospice Claim shall include:
Profile specific implementation guidance:
Description of Profiles, Differentials, and Snapshots.
The official URL for this profile is: https://bluebutton.cms.gov/assets/ig/StructureDefinition-bluebutton-hospice-claim.html
Published on Wed Mar 21 16:11:24 UTC 2018 as a draft by CMS Blue Button 2.0 Team.
This profile builds on ExplanationOfBenefit
ExplanationOfBenefit.identifier
identifier.system
identifier.value
that is unique within the system.One status in ExplanationOfBenefit.status
ExplanationOfBenefit.type
type.coding
, and each coding must have:
- a coding.system
- a coding.code
ExplanationOfBenefit.patient
patient.reference
ExplanationOfBenefit.billablePeriod
billablePeriod.start
billablePeriod.end
ExplanationOfBenefit.insurance
insurance.coverage
, and a coverage must have:
- a coverage.reference
ExplanationOfBenefit.item
item.sequence
item.careTeamLinkId
item.revenue
, and each revenue must have:
revenue.coding
, and each coding must have:
- a coding.system
- a coding.code
revenue.hospice-rev-cntr-stus-ind-cd-extension
revenue.hospice-rev-cntr-ddctbl-coinsrnc-cd-extension
item.service
, and each service must have:
service.coding
, and each coding must have:
- a coding.system
- a coding.code
item.modifier
, and each modifier must have:
modifier.coding
, and each coding must have:
- a coding.system
- a coding.code
item.serviceDate
item.locationAddress
, and each locationAddress must have:
locationAddress.state
item.quantity
, and each quantity must have:
- a quantity.value
item.adjudication
, and each adjudication must have:
- an adjudication.category
, and each category must have:
- a category.coding
, and each coding must have:
- a coding.system
- a coding.code
adjudication.reason
, and each reason must have:
- a reason.coding
, and each coding must have:
- a coding.system
- a coding.code
adjudication.amount
, and each amount must have:
- a amount.value
- a amount.system
- a amount.code
item.hospice-rev-cntr-ndc-qty-extension
ExplanationOfBenefit.payment
payment.amount
, and each amount must have:
amount.value
amount.system
ExplanationOfBenefit
extensions:
- ExplanationOfBenefit.hospice-clm-mdcr-non-pmt-rsn-cd-extension
- ExplanationOfBenefit.hospice-prpayamt-extension
- ExplanationOfBenefit.hospice-fi-num-extension
Additionally your system must support:
ExplanationOfBenefit.provider
provider.identifier
ExplanationOfBenefit.organization
organization.identifier
ExplanationOfBenefit.facility
facility.identifier
facility.hospice-clm-fac-type-cd-extension
ExplanationOfBenefit.information
information.sequence
information.category
, and each category must have:
- a category.coding
, and each coding must have:
- a coding.system
- a coding.code
information.code
, and each cod must have:
ccod.coding
, and each coding must have:
- a coding.system
- a coding.code
information.value
ExplanationOfBenefit.careTeam
careTeam.sequence
careTeam.provider
, and each provider must have:
- a provider.identifer
careTeam.role
, and each role must have:
- a role.coding
, and each coding must have:
- a coding.system
- a coding.code
ExplanationOfBenefit.diagnosis
diagnosis.sequence
diagnosis.diagnosis
diagnosis.type
, and each type must have:
- a type.coding
, and each coding must have:
- a coding.system
- a coding.code
diagnoisis.packageCode, and each packageCode must have:
- a
packageCode.coding, and each coding must have:
- a
coding.system
- a
coding.code`ExplanationOfBenefit.hospitalization
hospitalization.start
hospitalization.end
ExplanationOfBenefit.totalCost
totalCost.value
information.system
information.code
ExplanationOfBenefit.BenefitBalance
BenefitBalance.category
, and each category must have:
- a category.coding
, and each coding must have:
- a coding.system
- a coding.code
BenefitBalance.financial, and each financial must have:
- a
financial.type, and each type must have:
- a
type.coding, and each coding must have:
- a
coding.system
- a
coding.code
- a
type.used`Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ExplanationOfBenefit | 0..* | Explanation of Benefit resource | ||
id | 1.. | |||
meta | ..0 | |||
implicitRules | ..0 | |||
language | ..0 | |||
text | ..0 | |||
contained | ..0 | |||
identifier | 1.. | |||
id | ..0 | |||
use | ..0 | |||
type | ..0 | |||
system | 1.. | |||
value | 1.. | |||
period | ..0 | |||
assigner | ..0 | |||
status | 1.. | |||
type | 1.. | |||
id | ..0 | |||
coding | 1.. | |||
id | ..0 | |||
system | 1.. | |||
version | ..0 | |||
code | 1.. | |||
display | 1.. | |||
userSelected | ..0 | |||
subType | ..0 | |||
patient | 1.. | |||
id | ..0 | |||
reference | 1.. | |||
identifier | ..0 | |||
display | ..0 | |||
billablePeriod | 1.. | |||
id | ..0 | |||
start | 1.. | |||
end | 1.. | |||
created | ..0 | |||
enterer | ..0 | |||
insurer | ..0 | |||
referral | ..0 | |||
claim | ..0 | |||
claimResponse | ..0 | |||
outcome | ..0 | |||
disposition | ..0 | |||
related | ..0 | |||
prescription | ..0 | |||
originalPrescription | ..0 | |||
payee | ..0 | |||
procedure | ..0 | |||
precedence | ..0 | |||
insurance | 1.. | |||
id | ..0 | |||
coverage | 1.. | |||
id | ..0 | |||
reference | 1.. | |||
identifier | ..0 | |||
display | ..0 | |||
preAuthRef | ..0 | |||
accident | ..0 | |||
employmentImpacted | ..0 | |||
item | 1.. | |||
id | ..0 | |||
careTeamLinkId | ..1 | |||
diagnosisLinkId | ..0 | |||
procedureLinkId | ..0 | |||
informationLinkId | ..0 | |||
category | ..0 | |||
programCode | ..0 | |||
servicedDate | date | |||
id | ..0 | |||
locationAddress | Address | |||
id | ..0 | |||
use | ..0 | |||
type | ..0 | |||
text | ..0 | |||
line | ..0 | |||
city | ..0 | |||
district | ..0 | |||
state | 1.. | |||
postalCode | ..0 | |||
country | ..0 | |||
period | ..0 | |||
unitPrice | ..0 | |||
factor | ..0 | |||
net | ..0 | |||
udi | ..0 | |||
bodySite | ..0 | |||
subSite | ..0 | |||
encounter | ..0 | |||
noteNumber | ..0 | |||
detail | ..0 | |||
bluebutton-hospice-rev-cntr-ndc-qty-extension | 1..1 | Quantity | Revenue Center National Drug Code (NDC) Quantity URL: https://bluebutton.cms.gov/assets/ig/StructureDefinition-bluebutton-hospice-rev-cntr-ndc-qty-extension | |
addItem | ..0 | |||
unallocdeductible | ..0 | |||
totalBenefit | ..0 | |||
payment | 1.. | |||
id | ..0 | |||
type | ..0 | |||
adjustment | ..0 | |||
adjustmentReason | ..0 | |||
date | ..0 | |||
amount | 1.. | |||
id | ..0 | |||
value | 1.. | |||
comparator | ..0 | |||
unit | ..0 | |||
system | 1.. | |||
code | ..0 | |||
identifier | ..0 | |||
form | ..0 | |||
processNote | ..0 | |||
bluebutton-hospice-clm-mdcr-non-pmt-rsn-cd-extension | 1..1 | Coding | Claim Medicare Non Payment Reason Code URL: https://bluebutton.cms.gov/assets/ig/StructureDefinition-bluebutton-hospice-clm-mdcr-non-pmt-rsn-cd-extension | |
bluebutton-hospice-prpayamt-extension | 1..1 | Money | NCH Primary Payer (if not Medicare) Claim Paid Amount URL: https://bluebutton.cms.gov/assets/ig/StructureDefinition-bluebutton-hospice-prpayamt-extension | |
bluebutton-hospice-fi-num-extension | 1..1 | Identifier | FI or MAC Number URL: https://bluebutton.cms.gov/assets/ig/StructureDefinition-bluebutton-hospice-fi-num-extension | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ExplanationOfBenefit | 0..* | Explanation of Benefit resource | ||
id | Σ | 1..1 | id | Logical id of this artifact |
bluebutton-hospice-clm-mdcr-non-pmt-rsn-cd-extension | 1..1 | Coding | Claim Medicare Non Payment Reason Code URL: https://bluebutton.cms.gov/assets/ig/StructureDefinition-bluebutton-hospice-clm-mdcr-non-pmt-rsn-cd-extension Binding: Claim Medicare Non Payment Reason Code (required) | |
bluebutton-hospice-prpayamt-extension | 1..1 | Money | NCH Primary Payer (if not Medicare) Claim Paid Amount URL: https://bluebutton.cms.gov/assets/ig/StructureDefinition-bluebutton-hospice-prpayamt-extension | |
bluebutton-hospice-fi-num-extension | 1..1 | Identifier | FI or MAC Number URL: https://bluebutton.cms.gov/assets/ig/StructureDefinition-bluebutton-hospice-fi-num-extension | |
identifier | 1..* | Identifier | Business Identifier | |
system | Σ | 1..1 | uri | The namespace for the identifier value Example General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri |
value | Σ | 1..1 | string | The value that is unique Example General': 123456 |
status | ?!Σ | 1..1 | code | active | cancelled | draft | entered-in-error Binding: ExplanationOfBenefitStatus (required) |
type | 1..1 | CodeableConcept | Type or discipline Binding: Example Claim Type Codes (required) | |
coding | Σ | 1..* | Coding | Code defined by a terminology system |
system | Σ | 1..1 | uri | Identity of the terminology system |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
display | Σ | 1..1 | string | Representation defined by the system |
text | Σ | 0..1 | string | Plain text representation of the concept |
patient | 1..1 | Reference(Patient) | The subject of the Products and Services | |
reference | Σ | 1..1 | string | Literal reference, Relative, internal or absolute URL |
billablePeriod | 1..1 | Period | Period for charge submission | |
start | Σ | 1..1 | dateTime | Starting time with inclusive boundary |
end | Σ | 1..1 | dateTime | End time with inclusive boundary, if not ongoing |
provider | 0..1 | Reference(Practitioner) | Responsible provider for the claim | |
identifier | Σ | 1..1 | Identifier | Logical reference, when literal reference is not known |
organization | 0..1 | Reference(Organization) | Responsible organization for the claim | |
identifier | Σ | 1..1 | Identifier | Logical reference, when literal reference is not known |
facility | 0..1 | Reference(Location) | Servicing Facility | |
bluebutton-hospice-clm-fac-type-cd-extension | 1..1 | Coding | Claim Facility Type Code URL: https://bluebutton.cms.gov/assets/ig/StructureDefinition-bluebutton-hospice-clm-fac-type-cd-extension Binding: Claim Facility Type Code (required) | |
identifier | Σ | 1..1 | Identifier | Logical reference, when literal reference is not known |
information | 0..* | BackboneElement | Exceptions, special considerations, the condition, situation, prior or concurrent issues Binding: Information Categories (required) | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
sequence | 1..1 | positiveInt | Information instance identifier | |
category | 1..1 | CodeableConcept | General class of information Binding: Claim Information Category Codes (example) | |
coding | Σ | 1..1 | Coding | Code defined by a terminology system |
system | Σ | 1..1 | uri | Identity of the terminology system |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
display | Σ | 1..1 | string | Representation defined by the system |
code | 1..1 | CodeableConcept | Type of information Binding: Exception Codes (example) | |
coding | Σ | 1..1 | Coding | Code defined by a terminology system |
system | Σ | 1..1 | uri | Identity of the terminology system |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
display | Σ | 1..1 | string | Representation defined by the system |
value[x] | 0..1 | string, Quantity, Attachment, Reference(Resource) | Additional Data or supporting information | |
careTeam | 0..* | BackboneElement | Care Team members | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
sequence | 1..1 | positiveInt | Number to covey order of careteam | |
provider | 1..1 | Reference(Practitioner), Reference(Organization) | Member of the Care Team | |
identifier | Σ | 1..1 | Identifier | Logical reference, when literal reference is not known |
role | 0..1 | CodeableConcept | Role on the team Binding: Claim Care Team Role Codes (example) | |
coding | Σ | 1..1 | Coding | Code defined by a terminology system |
system | Σ | 1..1 | uri | Identity of the terminology system |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
display | Σ | 1..1 | string | Representation defined by the system |
diagnosis | 0..* | BackboneElement | List of Diagnosis | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
sequence | 1..1 | positiveInt | Number to covey order of diagnosis | |
diagnosis[x] | 1..1 | CodeableConcept, Reference(Condition) | Patient's diagnosis Binding: ICD-10 Codes (example) | |
type | 0..1 | CodeableConcept | Timing or nature of the diagnosis Binding: Example Diagnosis Type Codes (example) | |
coding | Σ | 0..* | Coding | Code defined by a terminology system |
system | Σ | 0..1 | uri | Identity of the terminology system |
code | Σ | 0..1 | code | Symbol in syntax defined by the system |
packageCode | 0..1 | CodeableConcept | Package billing code Binding: Example Diagnosis Related Group Codes (example) | |
coding | Σ | 1..1 | Coding | Code defined by a terminology system |
system | Σ | 1..1 | uri | Identity of the terminology system |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
insurance | 1..1 | BackboneElement | Insurance or medical plan | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
coverage | 1..1 | Reference(Coverage) | Insurance information | |
reference | Σ | 1..1 | string | Literal reference, Relative, internal or absolute URL |
hospitalization | 0..1 | Period | Period in hospital | |
bluebutton-hospice-bene-hospc-prd-cnt-extension | 1..1 | Quantity | Beneficiary's Hospice Period Count URL: https://bluebutton.cms.gov/assets/ig/StructureDefinition-bluebutton-hospice-bene-hospc-prd-cnt-extension | |
start | Σ | 1..1 | dateTime | Starting time with inclusive boundary |
end | Σ | 1..1 | dateTime | End time with inclusive boundary, if not ongoing |
item | 1..* | BackboneElement | Goods and Services | |
bluebutton-hospice-rev-cntr-ndc-qty-extension | 1..1 | Quantity | Revenue Center National Drug Code (NDC) Quantity URL: https://bluebutton.cms.gov/assets/ig/StructureDefinition-bluebutton-hospice-rev-cntr-ndc-qty-extension Binding: Revenue Center NDC Quantity Qualifier Code (required) | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
sequence | 1..1 | positiveInt | Service instance | |
careTeamLinkId | 0..1 | positiveInt | Applicable careteam members | |
revenue | 0..1 | CodeableConcept | Revenue or cost center code Binding: Example Revenue Center Codes (example) | |
bluebutton-hospice-rev-cntr-ddctbl-coinsrnc-cd-extension | 1..1 | Coding | Revenue Center Deductible Coinsurance Code URL: https://bluebutton.cms.gov/assets/ig/StructureDefinition-bluebutton-hospice-rev-cntr-ddctbl-coinsrnc-cd-extension Binding: Revenue Center Deductible Coinsurance Code (required) | |
coding | Σ | 1..1 | Coding | Code defined by a terminology system |
system | Σ | 1..1 | uri | Identity of the terminology system |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
service | 0..1 | CodeableConcept | Billing Code Binding: USCLS Codes (example) | |
coding | Σ | 0..* | Coding | Code defined by a terminology system |
system | Σ | 1..1 | uri | Identity of the terminology system |
version | Σ | 1..1 | string | Version of the system - if relevant |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
modifier | 0..* | CodeableConcept | Service/Product billing modifiers Binding: Modifier type Codes (example) | |
coding | Σ | 0..* | Coding | Code defined by a terminology system |
system | Σ | 1..1 | uri | Identity of the terminology system |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
servicedDate | 0..1 | date | Date or dates of Service | |
value | 0..1 | Primitive value for date | ||
locationAddress | 0..1 | Address | Place of service Binding: Example Service Place Codes (example) | |
state | Σ | 1..1 | string | Sub-unit of country (abbreviations ok) |
quantity | 0..1 | SimpleQuantity | Count of Products or Services | |
value | Σ | 0..1 | decimal | Numerical value (with implicit precision) |
adjudication | 0..* | BackboneElement | Adjudication details | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
category | 1..1 | CodeableConcept | Adjudication category such as co-pay, eligible, benefit, etc. Binding: Adjudication Value Codes (example) | |
coding | Σ | 0..* | Coding | Code defined by a terminology system |
system | Σ | 1..1 | uri | Identity of the terminology system |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
display | Σ | 1..1 | string | Representation defined by the system |
reason | 0..1 | CodeableConcept | Explanation of Adjudication outcome Binding: Adjudication Reason Codes (example) | |
coding | Σ | 0..* | Coding | Code defined by a terminology system |
system | Σ | 1..1 | uri | Identity of the terminology system |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
amount | 0..1 | Money | Monetary amount | |
value | Σ | 1..1 | decimal | Numerical value (with implicit precision) |
system | Σ | 1..1 | uri | System that defines coded unit form |
code | Σ | 1..1 | code | Coded form of the unit |
totalCost | 0..1 | Money | Total Cost of service from the Claim | |
value | Σ | 1..1 | decimal | Numerical value (with implicit precision) |
system | Σ | 1..1 | uri | System that defines coded unit form |
code | Σ | 1..1 | code | Coded form of the unit |
payment | 1..1 | BackboneElement | Payment (if paid) | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
amount | 1..1 | Money | Payable amount after adjustment | |
value | Σ | 1..1 | decimal | Numerical value (with implicit precision) |
system | Σ | 1..1 | uri | System that defines coded unit form |
benefitBalance | 0..* | BackboneElement | Balance by Benefit Category | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
category | 1..1 | CodeableConcept | Type of services covered Binding: Benefit Category Codes (example) | |
coding | Σ | 1..1 | Coding | Code defined by a terminology system |
system | Σ | 1..1 | uri | Identity of the terminology system |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
display | Σ | 1..1 | string | Representation defined by the system |
financial | 0..* | BackboneElement | Benefit Summary | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
type | 1..1 | CodeableConcept | deductible, visits, benefit amount Binding: Benefit Type Codes (example) | |
coding | Σ | 1..1 | Coding | Code defined by a terminology system |
system | Σ | 1..1 | uri | Identity of the terminology system |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
display | Σ | 1..1 | string | Representation defined by the system |
used[x] | 1..1 | unsignedInt, Money | Benefits used | |
Documentation for this format |
ExplanationOfBenefit.identifier
identifier.system
identifier.value
that is unique within the system.One status in ExplanationOfBenefit.status
ExplanationOfBenefit.type
type.coding
, and each coding must have:
- a coding.system
- a coding.code
ExplanationOfBenefit.patient
patient.reference
ExplanationOfBenefit.billablePeriod
billablePeriod.start
billablePeriod.end
ExplanationOfBenefit.insurance
insurance.coverage
, and a coverage must have:
- a coverage.reference
ExplanationOfBenefit.item
item.sequence
item.careTeamLinkId
item.revenue
, and each revenue must have:
revenue.coding
, and each coding must have:
- a coding.system
- a coding.code
revenue.hospice-rev-cntr-stus-ind-cd-extension
revenue.hospice-rev-cntr-ddctbl-coinsrnc-cd-extension
item.service
, and each service must have:
service.coding
, and each coding must have:
- a coding.system
- a coding.code
item.modifier
, and each modifier must have:
modifier.coding
, and each coding must have:
- a coding.system
- a coding.code
item.serviceDate
item.locationAddress
, and each locationAddress must have:
locationAddress.state
item.quantity
, and each quantity must have:
- a quantity.value
item.adjudication
, and each adjudication must have:
- an adjudication.category
, and each category must have:
- a category.coding
, and each coding must have:
- a coding.system
- a coding.code
adjudication.reason
, and each reason must have:
- a reason.coding
, and each coding must have:
- a coding.system
- a coding.code
adjudication.amount
, and each amount must have:
- a amount.value
- a amount.system
- a amount.code
item.hospice-rev-cntr-ndc-qty-extension
ExplanationOfBenefit.payment
payment.amount
, and each amount must have:
amount.value
amount.system
ExplanationOfBenefit
extensions:
- ExplanationOfBenefit.hospice-clm-mdcr-non-pmt-rsn-cd-extension
- ExplanationOfBenefit.hospice-prpayamt-extension
- ExplanationOfBenefit.hospice-fi-num-extension
Additionally your system must support:
ExplanationOfBenefit.provider
provider.identifier
ExplanationOfBenefit.organization
organization.identifier
ExplanationOfBenefit.facility
facility.identifier
facility.hospice-clm-fac-type-cd-extension
ExplanationOfBenefit.information
information.sequence
information.category
, and each category must have:
- a category.coding
, and each coding must have:
- a coding.system
- a coding.code
information.code
, and each cod must have:
ccod.coding
, and each coding must have:
- a coding.system
- a coding.code
information.value
ExplanationOfBenefit.careTeam
careTeam.sequence
careTeam.provider
, and each provider must have:
- a provider.identifer
careTeam.role
, and each role must have:
- a role.coding
, and each coding must have:
- a coding.system
- a coding.code
ExplanationOfBenefit.diagnosis
diagnosis.sequence
diagnosis.diagnosis
diagnosis.type
, and each type must have:
- a type.coding
, and each coding must have:
- a coding.system
- a coding.code
diagnoisis.packageCode, and each packageCode must have:
- a
packageCode.coding, and each coding must have:
- a
coding.system
- a
coding.code`ExplanationOfBenefit.hospitalization
hospitalization.start
hospitalization.end
ExplanationOfBenefit.totalCost
totalCost.value
information.system
information.code
ExplanationOfBenefit.BenefitBalance
BenefitBalance.category
, and each category must have:
- a category.coding
, and each coding must have:
- a coding.system
- a coding.code
BenefitBalance.financial, and each financial must have:
- a
financial.type, and each type must have:
- a
type.coding, and each coding must have:
- a
coding.system
- a
coding.code
- a
type.used`Differential View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ExplanationOfBenefit | 0..* | Explanation of Benefit resource | ||
id | 1.. | |||
meta | ..0 | |||
implicitRules | ..0 | |||
language | ..0 | |||
text | ..0 | |||
contained | ..0 | |||
identifier | 1.. | |||
id | ..0 | |||
use | ..0 | |||
type | ..0 | |||
system | 1.. | |||
value | 1.. | |||
period | ..0 | |||
assigner | ..0 | |||
status | 1.. | |||
type | 1.. | |||
id | ..0 | |||
coding | 1.. | |||
id | ..0 | |||
system | 1.. | |||
version | ..0 | |||
code | 1.. | |||
display | 1.. | |||
userSelected | ..0 | |||
subType | ..0 | |||
patient | 1.. | |||
id | ..0 | |||
reference | 1.. | |||
identifier | ..0 | |||
display | ..0 | |||
billablePeriod | 1.. | |||
id | ..0 | |||
start | 1.. | |||
end | 1.. | |||
created | ..0 | |||
enterer | ..0 | |||
insurer | ..0 | |||
referral | ..0 | |||
claim | ..0 | |||
claimResponse | ..0 | |||
outcome | ..0 | |||
disposition | ..0 | |||
related | ..0 | |||
prescription | ..0 | |||
originalPrescription | ..0 | |||
payee | ..0 | |||
procedure | ..0 | |||
precedence | ..0 | |||
insurance | 1.. | |||
id | ..0 | |||
coverage | 1.. | |||
id | ..0 | |||
reference | 1.. | |||
identifier | ..0 | |||
display | ..0 | |||
preAuthRef | ..0 | |||
accident | ..0 | |||
employmentImpacted | ..0 | |||
item | 1.. | |||
id | ..0 | |||
careTeamLinkId | ..1 | |||
diagnosisLinkId | ..0 | |||
procedureLinkId | ..0 | |||
informationLinkId | ..0 | |||
category | ..0 | |||
programCode | ..0 | |||
servicedDate | date | |||
id | ..0 | |||
locationAddress | Address | |||
id | ..0 | |||
use | ..0 | |||
type | ..0 | |||
text | ..0 | |||
line | ..0 | |||
city | ..0 | |||
district | ..0 | |||
state | 1.. | |||
postalCode | ..0 | |||
country | ..0 | |||
period | ..0 | |||
unitPrice | ..0 | |||
factor | ..0 | |||
net | ..0 | |||
udi | ..0 | |||
bodySite | ..0 | |||
subSite | ..0 | |||
encounter | ..0 | |||
noteNumber | ..0 | |||
detail | ..0 | |||
bluebutton-hospice-rev-cntr-ndc-qty-extension | 1..1 | Quantity | Revenue Center National Drug Code (NDC) Quantity URL: https://bluebutton.cms.gov/assets/ig/StructureDefinition-bluebutton-hospice-rev-cntr-ndc-qty-extension | |
addItem | ..0 | |||
unallocdeductible | ..0 | |||
totalBenefit | ..0 | |||
payment | 1.. | |||
id | ..0 | |||
type | ..0 | |||
adjustment | ..0 | |||
adjustmentReason | ..0 | |||
date | ..0 | |||
amount | 1.. | |||
id | ..0 | |||
value | 1.. | |||
comparator | ..0 | |||
unit | ..0 | |||
system | 1.. | |||
code | ..0 | |||
identifier | ..0 | |||
form | ..0 | |||
processNote | ..0 | |||
bluebutton-hospice-clm-mdcr-non-pmt-rsn-cd-extension | 1..1 | Coding | Claim Medicare Non Payment Reason Code URL: https://bluebutton.cms.gov/assets/ig/StructureDefinition-bluebutton-hospice-clm-mdcr-non-pmt-rsn-cd-extension | |
bluebutton-hospice-prpayamt-extension | 1..1 | Money | NCH Primary Payer (if not Medicare) Claim Paid Amount URL: https://bluebutton.cms.gov/assets/ig/StructureDefinition-bluebutton-hospice-prpayamt-extension | |
bluebutton-hospice-fi-num-extension | 1..1 | Identifier | FI or MAC Number URL: https://bluebutton.cms.gov/assets/ig/StructureDefinition-bluebutton-hospice-fi-num-extension | |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ExplanationOfBenefit | 0..* | Explanation of Benefit resource | ||
id | Σ | 1..1 | id | Logical id of this artifact |
bluebutton-hospice-clm-mdcr-non-pmt-rsn-cd-extension | 1..1 | Coding | Claim Medicare Non Payment Reason Code URL: https://bluebutton.cms.gov/assets/ig/StructureDefinition-bluebutton-hospice-clm-mdcr-non-pmt-rsn-cd-extension Binding: Claim Medicare Non Payment Reason Code (required) | |
bluebutton-hospice-prpayamt-extension | 1..1 | Money | NCH Primary Payer (if not Medicare) Claim Paid Amount URL: https://bluebutton.cms.gov/assets/ig/StructureDefinition-bluebutton-hospice-prpayamt-extension | |
bluebutton-hospice-fi-num-extension | 1..1 | Identifier | FI or MAC Number URL: https://bluebutton.cms.gov/assets/ig/StructureDefinition-bluebutton-hospice-fi-num-extension | |
identifier | 1..* | Identifier | Business Identifier | |
system | Σ | 1..1 | uri | The namespace for the identifier value Example General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri |
value | Σ | 1..1 | string | The value that is unique Example General': 123456 |
status | ?!Σ | 1..1 | code | active | cancelled | draft | entered-in-error Binding: ExplanationOfBenefitStatus (required) |
type | 1..1 | CodeableConcept | Type or discipline Binding: Example Claim Type Codes (required) | |
coding | Σ | 1..* | Coding | Code defined by a terminology system |
system | Σ | 1..1 | uri | Identity of the terminology system |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
display | Σ | 1..1 | string | Representation defined by the system |
text | Σ | 0..1 | string | Plain text representation of the concept |
patient | 1..1 | Reference(Patient) | The subject of the Products and Services | |
reference | Σ | 1..1 | string | Literal reference, Relative, internal or absolute URL |
billablePeriod | 1..1 | Period | Period for charge submission | |
start | Σ | 1..1 | dateTime | Starting time with inclusive boundary |
end | Σ | 1..1 | dateTime | End time with inclusive boundary, if not ongoing |
provider | 0..1 | Reference(Practitioner) | Responsible provider for the claim | |
identifier | Σ | 1..1 | Identifier | Logical reference, when literal reference is not known |
organization | 0..1 | Reference(Organization) | Responsible organization for the claim | |
identifier | Σ | 1..1 | Identifier | Logical reference, when literal reference is not known |
facility | 0..1 | Reference(Location) | Servicing Facility | |
bluebutton-hospice-clm-fac-type-cd-extension | 1..1 | Coding | Claim Facility Type Code URL: https://bluebutton.cms.gov/assets/ig/StructureDefinition-bluebutton-hospice-clm-fac-type-cd-extension Binding: Claim Facility Type Code (required) | |
identifier | Σ | 1..1 | Identifier | Logical reference, when literal reference is not known |
information | 0..* | BackboneElement | Exceptions, special considerations, the condition, situation, prior or concurrent issues Binding: Information Categories (required) | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
sequence | 1..1 | positiveInt | Information instance identifier | |
category | 1..1 | CodeableConcept | General class of information Binding: Claim Information Category Codes (example) | |
coding | Σ | 1..1 | Coding | Code defined by a terminology system |
system | Σ | 1..1 | uri | Identity of the terminology system |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
display | Σ | 1..1 | string | Representation defined by the system |
code | 1..1 | CodeableConcept | Type of information Binding: Exception Codes (example) | |
coding | Σ | 1..1 | Coding | Code defined by a terminology system |
system | Σ | 1..1 | uri | Identity of the terminology system |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
display | Σ | 1..1 | string | Representation defined by the system |
value[x] | 0..1 | string, Quantity, Attachment, Reference(Resource) | Additional Data or supporting information | |
careTeam | 0..* | BackboneElement | Care Team members | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
sequence | 1..1 | positiveInt | Number to covey order of careteam | |
provider | 1..1 | Reference(Practitioner), Reference(Organization) | Member of the Care Team | |
identifier | Σ | 1..1 | Identifier | Logical reference, when literal reference is not known |
role | 0..1 | CodeableConcept | Role on the team Binding: Claim Care Team Role Codes (example) | |
coding | Σ | 1..1 | Coding | Code defined by a terminology system |
system | Σ | 1..1 | uri | Identity of the terminology system |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
display | Σ | 1..1 | string | Representation defined by the system |
diagnosis | 0..* | BackboneElement | List of Diagnosis | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
sequence | 1..1 | positiveInt | Number to covey order of diagnosis | |
diagnosis[x] | 1..1 | CodeableConcept, Reference(Condition) | Patient's diagnosis Binding: ICD-10 Codes (example) | |
type | 0..1 | CodeableConcept | Timing or nature of the diagnosis Binding: Example Diagnosis Type Codes (example) | |
coding | Σ | 0..* | Coding | Code defined by a terminology system |
system | Σ | 0..1 | uri | Identity of the terminology system |
code | Σ | 0..1 | code | Symbol in syntax defined by the system |
packageCode | 0..1 | CodeableConcept | Package billing code Binding: Example Diagnosis Related Group Codes (example) | |
coding | Σ | 1..1 | Coding | Code defined by a terminology system |
system | Σ | 1..1 | uri | Identity of the terminology system |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
insurance | 1..1 | BackboneElement | Insurance or medical plan | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
coverage | 1..1 | Reference(Coverage) | Insurance information | |
reference | Σ | 1..1 | string | Literal reference, Relative, internal or absolute URL |
hospitalization | 0..1 | Period | Period in hospital | |
bluebutton-hospice-bene-hospc-prd-cnt-extension | 1..1 | Quantity | Beneficiary's Hospice Period Count URL: https://bluebutton.cms.gov/assets/ig/StructureDefinition-bluebutton-hospice-bene-hospc-prd-cnt-extension | |
start | Σ | 1..1 | dateTime | Starting time with inclusive boundary |
end | Σ | 1..1 | dateTime | End time with inclusive boundary, if not ongoing |
item | 1..* | BackboneElement | Goods and Services | |
bluebutton-hospice-rev-cntr-ndc-qty-extension | 1..1 | Quantity | Revenue Center National Drug Code (NDC) Quantity URL: https://bluebutton.cms.gov/assets/ig/StructureDefinition-bluebutton-hospice-rev-cntr-ndc-qty-extension Binding: Revenue Center NDC Quantity Qualifier Code (required) | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
sequence | 1..1 | positiveInt | Service instance | |
careTeamLinkId | 0..1 | positiveInt | Applicable careteam members | |
revenue | 0..1 | CodeableConcept | Revenue or cost center code Binding: Example Revenue Center Codes (example) | |
bluebutton-hospice-rev-cntr-ddctbl-coinsrnc-cd-extension | 1..1 | Coding | Revenue Center Deductible Coinsurance Code URL: https://bluebutton.cms.gov/assets/ig/StructureDefinition-bluebutton-hospice-rev-cntr-ddctbl-coinsrnc-cd-extension Binding: Revenue Center Deductible Coinsurance Code (required) | |
coding | Σ | 1..1 | Coding | Code defined by a terminology system |
system | Σ | 1..1 | uri | Identity of the terminology system |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
service | 0..1 | CodeableConcept | Billing Code Binding: USCLS Codes (example) | |
coding | Σ | 0..* | Coding | Code defined by a terminology system |
system | Σ | 1..1 | uri | Identity of the terminology system |
version | Σ | 1..1 | string | Version of the system - if relevant |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
modifier | 0..* | CodeableConcept | Service/Product billing modifiers Binding: Modifier type Codes (example) | |
coding | Σ | 0..* | Coding | Code defined by a terminology system |
system | Σ | 1..1 | uri | Identity of the terminology system |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
servicedDate | 0..1 | date | Date or dates of Service | |
value | 0..1 | Primitive value for date | ||
locationAddress | 0..1 | Address | Place of service Binding: Example Service Place Codes (example) | |
state | Σ | 1..1 | string | Sub-unit of country (abbreviations ok) |
quantity | 0..1 | SimpleQuantity | Count of Products or Services | |
value | Σ | 0..1 | decimal | Numerical value (with implicit precision) |
adjudication | 0..* | BackboneElement | Adjudication details | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
category | 1..1 | CodeableConcept | Adjudication category such as co-pay, eligible, benefit, etc. Binding: Adjudication Value Codes (example) | |
coding | Σ | 0..* | Coding | Code defined by a terminology system |
system | Σ | 1..1 | uri | Identity of the terminology system |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
display | Σ | 1..1 | string | Representation defined by the system |
reason | 0..1 | CodeableConcept | Explanation of Adjudication outcome Binding: Adjudication Reason Codes (example) | |
coding | Σ | 0..* | Coding | Code defined by a terminology system |
system | Σ | 1..1 | uri | Identity of the terminology system |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
amount | 0..1 | Money | Monetary amount | |
value | Σ | 1..1 | decimal | Numerical value (with implicit precision) |
system | Σ | 1..1 | uri | System that defines coded unit form |
code | Σ | 1..1 | code | Coded form of the unit |
totalCost | 0..1 | Money | Total Cost of service from the Claim | |
value | Σ | 1..1 | decimal | Numerical value (with implicit precision) |
system | Σ | 1..1 | uri | System that defines coded unit form |
code | Σ | 1..1 | code | Coded form of the unit |
payment | 1..1 | BackboneElement | Payment (if paid) | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
amount | 1..1 | Money | Payable amount after adjustment | |
value | Σ | 1..1 | decimal | Numerical value (with implicit precision) |
system | Σ | 1..1 | uri | System that defines coded unit form |
benefitBalance | 0..* | BackboneElement | Balance by Benefit Category | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
category | 1..1 | CodeableConcept | Type of services covered Binding: Benefit Category Codes (example) | |
coding | Σ | 1..1 | Coding | Code defined by a terminology system |
system | Σ | 1..1 | uri | Identity of the terminology system |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
display | Σ | 1..1 | string | Representation defined by the system |
financial | 0..* | BackboneElement | Benefit Summary | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
type | 1..1 | CodeableConcept | deductible, visits, benefit amount Binding: Benefit Type Codes (example) | |
coding | Σ | 1..1 | Coding | Code defined by a terminology system |
system | Σ | 1..1 | uri | Identity of the terminology system |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
display | Σ | 1..1 | string | Representation defined by the system |
used[x] | 1..1 | unsignedInt, Money | Benefits used | |
Documentation for this format |
Downloads: StructureDefinition: (XML, JSON, CSV), Schema: XML Schematron