PREFIX fhir:
PREFIX fhirvs:
PREFIX xsd:
BASE
start=@ AND {fhir:nodeRole [fhir:treeRoot]}
# Response to a claim predetermination or preauthorization
CLOSED {
a [fhir:ClaimResponse];
fhir:nodeRole [fhir:treeRoot]?;
fhir:Resource.id id?; # Logical id of this artifact
fhir:Resource.meta @?; # Metadata about the resource
fhir:Resource.implicitRules @?; # A set of rules under which this
# content was created
fhir:Resource.language @?; # Language of the resource content
fhir:DomainResource.text @?; # Text summary of the resource, for
# human interpretation
fhir:DomainResource.contained @*; # Contained, inline Resources
fhir:DomainResource.extension @*; # Additional content defined by
# implementations
fhir:DomainResource.modifierExtension @*; # Extensions that cannot be ignored
fhir:ClaimResponse.identifier @*; # Business Identifier for a claim
# response
fhir:ClaimResponse.status @ AND
{fhir:value @fhirvs:fm-status}; # active | cancelled | draft |
# entered-in-error
fhir:ClaimResponse.type @; # More granular claim type
fhir:ClaimResponse.subType @?; # More granular claim type
fhir:ClaimResponse.use @ AND
{fhir:value @fhirvs:claim-use}; # claim | preauthorization |
# predetermination
fhir:ClaimResponse.patient @; # The recipient of the products and
# services
fhir:ClaimResponse.created @; # Response creation date
fhir:ClaimResponse.insurer @; # Party responsible for reimbursement
fhir:ClaimResponse.requestor @?; # Party responsible for the claim
fhir:ClaimResponse.request @?; # Id of resource triggering
# adjudication
fhir:ClaimResponse.outcome @ AND
{fhir:value @fhirvs:remittance-outcome}; # queued | complete | error | partial
fhir:ClaimResponse.disposition @?; # Disposition Message
fhir:ClaimResponse.preAuthRef @?; # Preauthorization reference
fhir:ClaimResponse.preAuthPeriod @?; # Preauthorization reference
# effective period
fhir:ClaimResponse.payeeType @?; # Party to be paid any benefits
# payable
fhir:ClaimResponse.item @*; # Adjudication for claim line items
fhir:ClaimResponse.addItem @*; # Insurer added line items
fhir:ClaimResponse.adjudication @*; # Header-level adjudication
fhir:ClaimResponse.total @*; # Adjudication totals
fhir:ClaimResponse.payment @?; # Payment Details
fhir:ClaimResponse.fundsReserve @?; # Funds reserved status
fhir:ClaimResponse.formCode @?; # Printed form identifier
fhir:ClaimResponse.form @?; # Printed reference or actual form
fhir:ClaimResponse.processNote @*; # Note concerning adjudication
fhir:ClaimResponse.communicationRequest @*; # Request for additional information
fhir:ClaimResponse.insurance @*; # Patient insurance information
fhir:ClaimResponse.error @*; # Processing errors
fhir:index xsd:integer? # Relative position in a list
}
# Note concerning adjudication
CLOSED {
fhir:Element.id string?; # Unique id for inter-element
# referencing
fhir:Element.extension @*; # Additional content defined by
# implementations
fhir:BackboneElement.modifierExtension @*; # Extensions that cannot be ignored
# even if unrecognized
fhir:ClaimResponse.processNote.number @?; # Note instance identifier
fhir:ClaimResponse.processNote.type @ AND
{fhir:value @fhirvs:note-type}?; # display | print | printoper
fhir:ClaimResponse.processNote.text @; # Note explanatory text
fhir:ClaimResponse.processNote.language @?; # Language of the text
fhir:index xsd:integer? # Relative position in a list
}
# Processing errors
CLOSED {
fhir:Element.id string?; # Unique id for inter-element
# referencing
fhir:Element.extension @*; # Additional content defined by
# implementations
fhir:BackboneElement.modifierExtension @*; # Extensions that cannot be ignored
# even if unrecognized
fhir:ClaimResponse.error.itemSequence @?; # Item sequence number
fhir:ClaimResponse.error.detailSequence @?; # Detail sequence number
fhir:ClaimResponse.error.subDetailSequence @?; # Subdetail sequence number
fhir:ClaimResponse.error.code @; # Error code detailing processing
# issues
fhir:index xsd:integer? # Relative position in a list
}
# Insurer added line items
CLOSED {
fhir:Element.id string?; # Unique id for inter-element
# referencing
fhir:Element.extension @*; # Additional content defined by
# implementations
fhir:BackboneElement.modifierExtension @*; # Extensions that cannot be ignored
# even if unrecognized
fhir:ClaimResponse.addItem.itemSequence @*; # Item sequence number
fhir:ClaimResponse.addItem.detailSequence @*; # Detail sequence number
fhir:ClaimResponse.addItem.subdetailSequence @*; # Subdetail sequence number
fhir:ClaimResponse.addItem.provider @*; # Authorized providers
fhir:ClaimResponse.addItem.productOrService @; # Billing, service, product, or drug
# code
fhir:ClaimResponse.addItem.modifier @*; # Service/Product billing modifiers
fhir:ClaimResponse.addItem.programCode @*; # Program the product or service is
# provided under
( # Date or dates of service or
# product delivery
fhir:ClaimResponse.addItem.servicedDate @ |
fhir:ClaimResponse.addItem.servicedPeriod @
)?;
( # Place of service or where product
# was supplied
fhir:ClaimResponse.addItem.locationCodeableConcept @ |
fhir:ClaimResponse.addItem.locationAddress @ |
fhir:ClaimResponse.addItem.locationReference @
)?;
fhir:ClaimResponse.addItem.quantity @?; # Count of products or services
fhir:ClaimResponse.addItem.unitPrice @?; # Fee, charge or cost per item
fhir:ClaimResponse.addItem.factor @?; # Price scaling factor
fhir:ClaimResponse.addItem.net @?; # Total item cost
fhir:ClaimResponse.addItem.bodySite @?; # Anatomical location
fhir:ClaimResponse.addItem.subSite @*; # Anatomical sub-location
fhir:ClaimResponse.addItem.noteNumber @*; # Applicable note numbers
fhir:ClaimResponse.addItem.adjudication @+; # Added items adjudication
fhir:ClaimResponse.addItem.detail @*; # Insurer added line details
fhir:index xsd:integer? # Relative position in a list
}
# Patient insurance information
CLOSED {
fhir:Element.id string?; # Unique id for inter-element
# referencing
fhir:Element.extension @*; # Additional content defined by
# implementations
fhir:BackboneElement.modifierExtension @*; # Extensions that cannot be ignored
# even if unrecognized
fhir:ClaimResponse.insurance.sequence @; # Insurance instance identifier
fhir:ClaimResponse.insurance.focal @; # Coverage to be used for
# adjudication
fhir:ClaimResponse.insurance.coverage @; # Insurance information
fhir:ClaimResponse.insurance.businessArrangement @?; # Additional provider contract number
fhir:ClaimResponse.insurance.claimResponse @?; # Adjudication results
fhir:index xsd:integer? # Relative position in a list
}
# Adjudication for claim line items
CLOSED {
fhir:Element.id string?; # Unique id for inter-element
# referencing
fhir:Element.extension @*; # Additional content defined by
# implementations
fhir:BackboneElement.modifierExtension @*; # Extensions that cannot be ignored
# even if unrecognized
fhir:ClaimResponse.item.itemSequence @; # Claim item instance identifier
fhir:ClaimResponse.item.noteNumber @*; # Applicable note numbers
fhir:ClaimResponse.item.adjudication @+; # Adjudication details
fhir:ClaimResponse.item.detail @*; # Adjudication for claim details
fhir:index xsd:integer? # Relative position in a list
}
# Header-level adjudication
CLOSED {
fhir:index xsd:integer? # Relative position in a list
}
# Adjudication totals
CLOSED {
fhir:Element.id string?; # Unique id for inter-element
# referencing
fhir:Element.extension @*; # Additional content defined by
# implementations
fhir:BackboneElement.modifierExtension @*; # Extensions that cannot be ignored
# even if unrecognized
fhir:ClaimResponse.total.category @; # Type of adjudication information
fhir:ClaimResponse.total.amount @; # Financial total for the category
fhir:index xsd:integer? # Relative position in a list
}
# Payment Details
CLOSED {
fhir:Element.id string?; # Unique id for inter-element
# referencing
fhir:Element.extension @*; # Additional content defined by
# implementations
fhir:BackboneElement.modifierExtension @*; # Extensions that cannot be ignored
# even if unrecognized
fhir:ClaimResponse.payment.type @; # Partial or complete payment
fhir:ClaimResponse.payment.adjustment @?; # Payment adjustment for non-claim
# issues
fhir:ClaimResponse.payment.adjustmentReason @?; # Explanation for the adjustment
fhir:ClaimResponse.payment.date @?; # Expected date of payment
fhir:ClaimResponse.payment.amount @; # Payable amount after adjustment
fhir:ClaimResponse.payment.identifier @?; # Business identifier for the payment
fhir:index xsd:integer? # Relative position in a list
}
# Insurer added line details
CLOSED {
fhir:Element.id string?; # Unique id for inter-element
# referencing
fhir:Element.extension @*; # Additional content defined by
# implementations
fhir:BackboneElement.modifierExtension @*; # Extensions that cannot be ignored
# even if unrecognized
fhir:ClaimResponse.addItem.detail.productOrService @; # Billing, service, product, or drug
# code
fhir:ClaimResponse.addItem.detail.modifier @*; # Service/Product billing modifiers
fhir:ClaimResponse.addItem.detail.quantity @?; # Count of products or services
fhir:ClaimResponse.addItem.detail.unitPrice @?; # Fee, charge or cost per item
fhir:ClaimResponse.addItem.detail.factor @?; # Price scaling factor
fhir:ClaimResponse.addItem.detail.net @?; # Total item cost
fhir:ClaimResponse.addItem.detail.noteNumber @*; # Applicable note numbers
fhir:ClaimResponse.addItem.detail.adjudication @+; # Added items detail adjudication
fhir:ClaimResponse.addItem.detail.subDetail @*; # Insurer added line items
fhir:index xsd:integer? # Relative position in a list
}
# Adjudication details
CLOSED {
fhir:Element.id string?; # Unique id for inter-element
# referencing
fhir:Element.extension @*; # Additional content defined by
# implementations
fhir:BackboneElement.modifierExtension @*; # Extensions that cannot be ignored
# even if unrecognized
fhir:ClaimResponse.item.adjudication.category @; # Type of adjudication information
fhir:ClaimResponse.item.adjudication.reason @?; # Explanation of adjudication outcome
fhir:ClaimResponse.item.adjudication.amount @?; # Monetary amount
fhir:ClaimResponse.item.adjudication.value @?; # Non-monetary value
fhir:index xsd:integer? # Relative position in a list
}
# Added items adjudication
CLOSED {
fhir:index xsd:integer? # Relative position in a list
}
# Adjudication for claim details
CLOSED {
fhir:Element.id string?; # Unique id for inter-element
# referencing
fhir:Element.extension @*; # Additional content defined by
# implementations
fhir:BackboneElement.modifierExtension @*; # Extensions that cannot be ignored
# even if unrecognized
fhir:ClaimResponse.item.detail.detailSequence @; # Claim detail instance identifier
fhir:ClaimResponse.item.detail.noteNumber @*; # Applicable note numbers
fhir:ClaimResponse.item.detail.adjudication @+; # Detail level adjudication details
fhir:ClaimResponse.item.detail.subDetail @*; # Adjudication for claim sub-details
fhir:index xsd:integer? # Relative position in a list
}
# Added items detail adjudication
CLOSED {
fhir:index xsd:integer? # Relative position in a list
}
# Adjudication for claim sub-details
CLOSED {
fhir:Element.id string?; # Unique id for inter-element
# referencing
fhir:Element.extension @*; # Additional content defined by
# implementations
fhir:BackboneElement.modifierExtension @*; # Extensions that cannot be ignored
# even if unrecognized
fhir:ClaimResponse.item.detail.subDetail.subDetailSequence @; # Claim sub-detail instance
# identifier
fhir:ClaimResponse.item.detail.subDetail.noteNumber @*; # Applicable note numbers
fhir:ClaimResponse.item.detail.subDetail.adjudication @*; # Subdetail level adjudication
# details
fhir:index xsd:integer? # Relative position in a list
}
# Detail level adjudication details
CLOSED {
fhir:index xsd:integer? # Relative position in a list
}
# Insurer added line items
CLOSED {
fhir:Element.id string?; # Unique id for inter-element
# referencing
fhir:Element.extension @*; # Additional content defined by
# implementations
fhir:BackboneElement.modifierExtension @*; # Extensions that cannot be ignored
# even if unrecognized
fhir:ClaimResponse.addItem.detail.subDetail.productOrService @; # Billing, service, product, or drug
# code
fhir:ClaimResponse.addItem.detail.subDetail.modifier @*; # Service/Product billing modifiers
fhir:ClaimResponse.addItem.detail.subDetail.quantity @?; # Count of products or services
fhir:ClaimResponse.addItem.detail.subDetail.unitPrice @?; # Fee, charge or cost per item
fhir:ClaimResponse.addItem.detail.subDetail.factor @?; # Price scaling factor
fhir:ClaimResponse.addItem.detail.subDetail.net @?; # Total item cost
fhir:ClaimResponse.addItem.detail.subDetail.noteNumber @*; # Applicable note numbers
fhir:ClaimResponse.addItem.detail.subDetail.adjudication @+; # Added items detail adjudication
fhir:index xsd:integer? # Relative position in a list
}
# Added items detail adjudication
CLOSED {
fhir:index xsd:integer? # Relative position in a list
}
# Subdetail level adjudication details
CLOSED {
fhir:index xsd:integer? # Relative position in a list
}
#---------------------- Data Types -------------------
# Primitive Type dateTime
CLOSED {
fhir:Element.id string?; # xml:id (or equivalent in JSON)
fhir:Element.extension @*; # Additional content defined by
# implementations
fhir:value dateTime?; # Primitive value for dateTime
fhir:index xsd:integer? # Relative position in a list
}
# Primitive Type date
CLOSED {
fhir:Element.id string?; # xml:id (or equivalent in JSON)
fhir:Element.extension @*; # Additional content defined by
# implementations
fhir:value date?; # Primitive value for date
fhir:index xsd:integer? # Relative position in a list
}
# Metadata about a resource
CLOSED {
fhir:Element.id id?; # Unique id for inter-element
# referencing
fhir:Element.extension @*; # Additional content defined by
# implementations
fhir:Meta.versionId @?; # Version specific identifier
fhir:Meta.lastUpdated @?; # When the resource version last
# changed
fhir:Meta.source @?; # Identifies where the resource
# comes from
fhir:Meta.profile @*; # Profiles this resource claims to
# conform to
fhir:Meta.security @*; # Security Labels applied to this
# resource
fhir:Meta.tag @*; # Tags applied to this resource
fhir:index xsd:integer? # Relative position in a list
}
# Primitive Type code
CLOSED {
fhir:Element.id string?; # xml:id (or equivalent in JSON)
fhir:Element.extension @*; # Additional content defined by
# implementations
fhir:value code?; # Primitive value for code
fhir:index xsd:integer? # Relative position in a list
}
# Primitive Type string
CLOSED {
fhir:Element.id string?; # xml:id (or equivalent in JSON)
fhir:Element.extension @*; # Additional content defined by
# implementations
fhir:value string MAXLENGTH 1048576?; # Primitive value for string
fhir:index xsd:integer? # Relative position in a list
}
# An address expressed using postal conventions (as opposed to GPS or other location definition formats)
CLOSED {
fhir:Element.id id?; # Unique id for inter-element
# referencing
fhir:Element.extension @*; # Additional content defined by
# implementations
fhir:Address.use @ AND
{fhir:value @fhirvs:address-use}?; # home | work | temp | old | billing
# - purpose of this address
fhir:Address.type @ AND
{fhir:value @fhirvs:address-type}?; # postal | physical | both
fhir:Address.text @?; # Text representation of the address
fhir:Address.line @*; # Street name, number, direction &
# P.O. Box etc.
fhir:Address.city @?; # Name of city, town etc.
fhir:Address.district @?; # District name (aka county)
fhir:Address.state @?; # Sub-unit of country (abbreviations
# ok)
fhir:Address.postalCode @?; # Postal code for area
fhir:Address.country @?; # Country (e.g. can be ISO 3166 2 or
# 3 letter code)
fhir:Address.period @?; # Time period when address was/is in
# use
fhir:index xsd:integer? # Relative position in a list
}
# A reference from one resource to another
CLOSED {
fhir:link IRI?;
fhir:Element.id id?; # Unique id for inter-element
# referencing
fhir:Element.extension @*; # Additional content defined by
# implementations
fhir:Reference.reference @?; # Literal reference, Relative,
# internal or absolute URL
fhir:Reference.type @?; # Type the reference refers to (e.g.
# "Patient")
fhir:Reference.identifier @?; # Logical reference, when literal
# reference is not known
fhir:Reference.display @?; # Text alternative for the resource
fhir:index xsd:integer? # Relative position in a list
}
# Base Resource
{a .+;
fhir:Resource.id id?; # Logical id of this artifact
fhir:Resource.meta @?; # Metadata about the resource
fhir:Resource.implicitRules @?; # A set of rules under which this
# content was created
fhir:Resource.language @?; # Language of the resource content
fhir:index xsd:integer?
}
# A fixed quantity (no comparator)
CLOSED {
fhir:Element.id id?; # Unique id for inter-element
# referencing
fhir:Element.extension @*; # Additional content defined by
# implementations
fhir:Quantity.value @?; # Numerical value (with implicit
# precision)
fhir:Quantity.unit @?; # Unit representation
fhir:Quantity.system @?; # System that defines coded unit form
fhir:Quantity.code @?; # Coded form of the unit
fhir:index xsd:integer? # Relative position in a list
}
# Time range defined by start and end date/time
CLOSED {
fhir:Element.id id?; # Unique id for inter-element
# referencing
fhir:Element.extension @*; # Additional content defined by
# implementations
fhir:Period.start @?; # Starting time with inclusive
# boundary
fhir:Period.end @?; # End time with inclusive boundary,
# if not ongoing
fhir:index xsd:integer? # Relative position in a list
}
# Content in a format defined elsewhere
CLOSED {
fhir:Element.id id?; # Unique id for inter-element
# referencing
fhir:Element.extension @*; # Additional content defined by
# implementations
fhir:Attachment.contentType @ AND
{fhir:value @fhirvs:mimetypes}?; # Mime type of the content, with
# charset etc.
fhir:Attachment.language @?; # Human language of the content
# (BCP-47)
fhir:Attachment.data @?; # Data inline, base64ed
fhir:Attachment.url @?; # Uri where the data can be found
fhir:Attachment.size @?; # Number of bytes of content (if url
# provided)
fhir:Attachment.hash @?; # Hash of the data (sha-1, base64ed)
fhir:Attachment.title @?; # Label to display in place of the
# data
fhir:Attachment.creation @?; # Date attachment was first created
fhir:index xsd:integer? # Relative position in a list
}
# Primitive Type uri
CLOSED {
fhir:Element.id string?; # xml:id (or equivalent in JSON)
fhir:Element.extension @*; # Additional content defined by
# implementations
fhir:value uri?; # Primitive value for uri
fhir:index xsd:integer? # Relative position in a list
}
# Optional Extensions Element
CLOSED {
fhir:Element.id id?;
fhir:Element.extension @*;
fhir:Extension.url uri;
(
fhir:Extension.valueBase64Binary @ |
fhir:Extension.valueBoolean @ |
fhir:Extension.valueCanonical @ |
fhir:Extension.valueCode @ |
fhir:Extension.valueDate @ |
fhir:Extension.valueDateTime @ |
fhir:Extension.valueDecimal @ |
fhir:Extension.valueId @ |
fhir:Extension.valueInstant @ |
fhir:Extension.valueInteger @ |
fhir:Extension.valueMarkdown @ |
fhir:Extension.valueOid @ |
fhir:Extension.valuePositiveInt @ |
fhir:Extension.valueString @ |
fhir:Extension.valueTime @