HSAAP Special Authority FHIR Implementation Guide
0.1.1 - draft New Zealand flag

HSAAP Special Authority FHIR Implementation Guide - Local Development build (v0.1.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: SAApprovalClaimResponse - Detailed Descriptions

Draft as of 2026-10-16

Definitions for the sa-approval-claimresponse resource profile.

See the documentation on how to interpret the contents of this table

0. ClaimResponse
Definition

This resource provides the adjudication details from the processing of a Claim resource.

ShortResponse to a claim predetermination or preauthorization
Control0..*
Is Modifierfalse
Summaryfalse
Alternate NamesRemittance Advice
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: 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 (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
sa-cr-1: Where both are present, ClaimResponse.identifier (Approval Number) and ClaimResponse.preAuthRef SHALL carry the same value. ((identifier.exists() and preAuthRef.exists()) implies identifier.value contains preAuthRef)
2. ClaimResponse.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

ShortMetadata about the resource
Control10..1
TypeMeta
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. ClaimResponse.meta.versionId
Definition

The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

ShortVersion specific identifier
Comments

The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

Control0..01
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. ClaimResponse.meta.lastUpdated
Definition

When the resource last changed - e.g. when the version changed.

ShortApproval version createdOn - orders versions by recency (D17)When the resource version last changed
Comments

This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

Control10..1
Typeinstant
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. ClaimResponse.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. ClaimResponse.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortExtensionAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control10..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on ClaimResponse.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

    12. ClaimResponse.extension:approvalDetail
    Slice NameapprovalDetail
    Definition

    Approval facts that have no existing FHIR element, including the Approval status and the provider (pharmacy) identity (D16, D24). Approval status is carried here because ClaimResponse.status is bound to the financial resource status value set, which cannot express ACTIVE, CANCELLED or REVOKED.

    formNumber and formVersion are facts about the Approval. They deliberately do not reuse the Questionnaire.url|version canonical used for submission (D16).

    ShortApproval Detail
    Control1..1
    This element is affected by the following invariants: ele-1
    TypeExtension(Approval Detail) (Complex Extension)
    Is Modifierfalse
    Must Supporttrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    sa-detail-1: providerIdType and providerId are either both present or both absent. (extension('providerIdType').exists() = extension('providerId').exists())
    14. ClaimResponse.extension:approvalCoverage
    Slice NameapprovalCoverage
    Definition

    Coverage of an Approval, carried only for EXPLICIT_PHARMACEUTICALS, PRODUCT_CATEGORY and ALL_PHARMACEUTICALS (D15). Absent for SCHEDULE_HIERARCHY coverage: a standard CHEM/RISK Approval's coverage is re-derivable from approval-detail.formNumber and formVersion against the schedule (D6). NPPA and panel Approvals have no schedule form to derive coverage from, so their coverage is carried explicitly.

    ShortApproval Coverage
    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(Approval Coverage) (Complex Extension)
    Is Modifierfalse
    Must Supporttrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    sa-cov-1: pharmaceutical is present if, and only if, type is EXPLICIT_PHARMACEUTICALS. (extension('pharmaceutical').exists() = extension('type').where(value = 'EXPLICIT_PHARMACEUTICALS').exists())
    sa-cov-2: category is present if, and only if, type is PRODUCT_CATEGORY. (extension('category').exists() = extension('type').where(value = 'PRODUCT_CATEGORY').exists())
    16. ClaimResponse.modifierExtension
    Definition

    May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

    ShortExtensions that cannot be ignored
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
    Summaryfalse
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    18. ClaimResponse.identifier
    Definition

    A unique identifier assigned to this claim response.

    ShortBusiness Identifier for a claim response
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control10..1*
    TypeIdentifier
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Requirements

    Allows claim responses to be distinguished and referenced.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    20. ClaimResponse.identifier.use
    Definition

    The purpose of this identifier.

    Shortusual | official | temp | secondary | old (If known)
    Comments

    Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

    Control0..1
    BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1
    (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

    Identifies the purpose for this identifier, if known .

    Typecode
    Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    22. ClaimResponse.identifier.system
    Definition

    Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

    ShortThe namespace for the identifier value
    Comments

    Identifier.system is always case sensitive.

    Control10..1
    Typeuri
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    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.

    Fixed Value
    {
      "system" : "https://fhir-ig.digital.health.nz/special-authority/ns/approval-number"
    }
    <system value="https://fhir-ig.digital.health.nz/special-authority/ns/approval-number"/>
    ExampleGeneral: http://www.acme.com/identifiers/patient
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    24. ClaimResponse.identifier.value
    Definition

    The portion of the identifier typically relevant to the user and which is unique within the context of the system.

    ShortThe value that is unique
    Comments

    If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. 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.

    Control10..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    ExampleGeneral: 123456
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    26. ClaimResponse.status
    Definition

    The status of the resource instance.

    Shortactive | cancelled | draft | entered-in-error
    Comments

    Always active. The Approval status is carried in approval-detail.status.


    This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

    Control1..1
    BindingThe codes SHALL be taken from FinancialResourceStatusCodeshttp://hl7.org/fhir/ValueSet/fm-status|4.0.1
    (required to http://hl7.org/fhir/ValueSet/fm-status|4.0.1)

    A code specifying the state of the resource instance.

    Typecode
    Is Modifiertrue because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    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'.

    Pattern Value
    {
      "status" : "active"
    }
    <status value="active"/>
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    28. ClaimResponse.type
    Definition

    A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.

    ShortMore granular claim type
    Comments

    This may contain the local bill type codes, for example the US UB-04 bill type code or the CMS bill type.

    Control1..1
    BindingUnless not suitable, these codes SHALL be taken from ClaimTypeCodeshttp://hl7.org/fhir/ValueSet/claim-type|4.0.1
    (extensible to http://hl7.org/fhir/ValueSet/claim-type|4.0.1)

    The type or discipline-style of the claim.

    TypeCodeableConcept
    Is Modifierfalse
    Summarytrue
    Requirements

    Some jurisdictions need a finer grained claim type for routing and adjudication.

    Pattern Value
    {
      "coding" : [
        {
          "system" : "http://terminology.hl7.org/CodeSystem/claim-type",
          "code" : "pharmacy"
        }
      ]
    }
    <type>
      <coding>
        <system value="http://terminology.hl7.org/CodeSystem/claim-type"/>
        <code value="pharmacy"/>
      </coding>
    </type>
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    30. ClaimResponse.subType
    Definition

    A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.

    ShortMore granular claim type
    Comments

    This may contain the local bill type codes, for example the US UB-04 bill type code or the CMS bill type.

    Control0..01
    BindingFor example codes, see ExampleClaimSubTypeCodeshttp://hl7.org/fhir/ValueSet/claim-subtype|4.0.1
    (example to http://hl7.org/fhir/ValueSet/claim-subtype|4.0.1)

    A more granular claim typecode.

    TypeCodeableConcept
    Is Modifierfalse
    Summaryfalse
    Requirements

    Some jurisdictions need a finer grained claim type for routing and adjudication.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    32. ClaimResponse.use
    Definition

    A code to indicate whether the nature of the request is: to request adjudication of products and services previously rendered; or requesting authorization and adjudication for provision in the future; or requesting the non-binding adjudication of the listed products and services which could be provided in the future.

    Shortclaim | preauthorization | predetermination
    Control1..1
    BindingThe codes SHALL be taken from Usehttp://hl7.org/fhir/ValueSet/claim-use|4.0.1
    (required to http://hl7.org/fhir/ValueSet/claim-use|4.0.1)

    Claim, preauthorization, predetermination.

    Typecode
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    This element is required to understand the nature of the request for adjudication.

    Pattern Value
    {
      "use" : "preauthorization"
    }
    <use value="preauthorization"/>
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    34. ClaimResponse.patient
    Definition

    The party to whom the professional services and/or products have been supplied or are being considered and for whom actual for facast reimbursement is sought.

    ShortThe recipient of the products and services
    Control1..1
    TypeReference(SA Patient, Patient)
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Requirements

    The patient must be supplied to the insurer so that confirmation of coverage and service hstory may be considered as part of the authorization and/or adjudiction.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    36. ClaimResponse.created
    Definition

    The date this resource was created.

    ShortResponse creation date
    Control1..1
    TypedateTime
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    Requirements

    Need to record a timestamp for use by both the recipient and the issuer.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    38. ClaimResponse.insurer
    Definition

    The party responsible for authorization, adjudication and reimbursement.

    ShortParty responsible for reimbursement
    Control1..1
    TypeReference(Organization)
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    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.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    40. ClaimResponse.insurer.reference
    Definition

    A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

    ShortLiteral reference, Relative, internal or absolute URL
    Comments

    Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

    Control0..01
    This element is affected by the following invariants: ref-1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    42. ClaimResponse.insurer.display
    Definition

    Plain text narrative that identifies the resource in addition to the resource reference.

    ShortText alternative for the resource
    Comments

    This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

    Control10..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    44. ClaimResponse.requestor
    Definition

    The provider which is responsible for the claim, predetermination or preauthorization.

    ShortPrescribing Practitioner who authored the originating ApplicationParty responsible for the claim
    Comments

    Typically this field would be 1..1 where this party is responsible for the claim but not necessarily professionally responsible for the provision of the individual products and services listed below.

    Control10..1
    TypeReference(SA Practitioner, Practitioner, PractitionerRole, Organization)
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    46. ClaimResponse.request
    Definition

    Original request resource reference.

    ShortThe originating Application, where still retrievableId of resource triggering adjudication
    Control0..1
    TypeReference(SA Claim, Claim)
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    48. ClaimResponse.outcome
    Definition

    The outcome of the claim, predetermination, or preauthorization processing.

    Shortqueued | complete | error | partial
    Comments

    Always complete. Carries no HSAAP meaning.


    The resource may be used to indicate that: the request has been held (queued) for processing; that it has been processed and errors found (error); that no errors were found and that some of the adjudication has been undertaken (partial) or that all of the adjudication has been undertaken (complete).

    Control1..1
    BindingThe codes SHALL be taken from ClaimProcessingCodeshttp://hl7.org/fhir/ValueSet/remittance-outcome|4.0.1
    (required to http://hl7.org/fhir/ValueSet/remittance-outcome|4.0.1)

    The result of the claim processing.

    Typecode
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    To advise the requestor of an overall processing outcome.

    Pattern Value
    {
      "outcome" : "complete"
    }
    <outcome value="complete"/>
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    50. ClaimResponse.preAuthRef
    Definition

    Reference from the Insurer which is used in later communications which refers to this adjudication.

    ShortPreauthorization reference
    Comments

    This value is only present on preauthorization adjudications.

    Control10..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summaryfalse
    Requirements

    On subsequent claims, the insurer may require the provider to quote this value.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    52. ClaimResponse.preAuthPeriod
    Definition

    The time frame during which this authorization is effective.

    ShortPreauthorization reference effective period
    Control10..1
    TypePeriod
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Requirements

    To convey to the provider when the authorized products and services must be supplied for the authorized adjudication to apply.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    54. ClaimResponse.preAuthPeriod.start
    Definition

    The start of the period. The boundary is inclusive.

    ShortStarting time with inclusive boundary
    Comments

    If the low element is missing, the meaning is that the low boundary is not known.

    Control10..1
    This element is affected by the following invariants: per-1
    TypedateTime
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    56. ClaimResponse.preAuthPeriod.end
    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.

    ShortEnd time with inclusive boundary, if not ongoing
    Comments

    The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.

    Control10..1
    This element is affected by the following invariants: per-1
    TypedateTime
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    Meaning if MissingIf the end of the period is missing, it means that the period is ongoing
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    58. ClaimResponse.payeeType
    Definition

    Type of Party to be reimbursed: subscriber, provider, other.

    ShortParty to be paid any benefits payable
    Control0..01
    BindingFor example codes, see Claim Payee Type Codeshttp://hl7.org/fhir/ValueSet/payeetype|4.0.1
    (example to http://hl7.org/fhir/ValueSet/payeetype|4.0.1)

    A code for the party to be reimbursed.

    TypeCodeableConcept
    Is Modifierfalse
    Summaryfalse
    Requirements

    Need to know who should receive payment with the most common situations being the Provider (assignment of benefits) or the Subscriber.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    60. ClaimResponse.item
    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.

    ShortAdjudication for claim line items
    Control0..0*
    TypeBackboneElement
    Is Modifierfalse
    Summaryfalse
    Requirements

    The adjudication for items provided on the claim.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    67. ClaimResponse.addItem
    Definition

    The first-tier service adjudications for payor added product or service lines.

    ShortInsurer added line items
    Control0..0*
    TypeBackboneElement
    Is Modifierfalse
    Summaryfalse
    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.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    72. ClaimResponse.adjudication
    Definition

    The adjudication results which are presented at the header level rather than at the line-item or add-item levels.

    ShortHeader-level adjudication
    Control0..0*
    TypeSeettp://hl7.org/fhir/StructureDefinition/ClaimResponse#ClaimResponse.item.adjudication
    Is Modifierfalse
    Summaryfalse
    Requirements

    Some insurers will receive line-items but provide the adjudication only at a summary or header-level.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    74. ClaimResponse.total
    Definition

    Categorized monetary totals for the adjudication.

    ShortAdjudication totals
    Comments

    Totals for amounts submitted, co-pays, benefits payable etc.

    Control0..0*
    TypeBackboneElement
    Is Modifierfalse
    Summarytrue
    Requirements

    To provide the requestor with financial totals by category for the adjudication.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    79. ClaimResponse.payment
    Definition

    Payment details for the adjudication of the claim.

    ShortPayment Details
    Control0..01
    TypeBackboneElement
    Is Modifierfalse
    Summaryfalse
    Requirements

    Needed to convey references to the financial instrument that has been used if payment has been made.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    84. ClaimResponse.fundsReserve
    Definition

    A code, used only on a response to a preauthorization, to indicate whether the benefits payable have been reserved and for whom.

    ShortFunds reserved status
    Comments

    Fund would be release by a future claim quoting the preAuthRef of this response. Examples of values include: provider, patient, none.

    Control0..01
    BindingFor example codes, see Funds Reservation Codeshttp://hl7.org/fhir/ValueSet/fundsreserve|4.0.1
    (example to http://hl7.org/fhir/ValueSet/fundsreserve|4.0.1)

    For whom funds are to be reserved: (Patient, Provider, None).

    TypeCodeableConcept
    Is Modifierfalse
    Summaryfalse
    Requirements

    Needed to advise the submitting provider on whether the rquest for reservation of funds has been honored.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    86. ClaimResponse.formCode
    Definition

    A code for the form to be used for printing the content.

    ShortPrinted form identifier
    Comments

    May be needed to identify specific jurisdictional forms.

    Control0..01
    BindingFor example codes, see Form Codeshttp://hl7.org/fhir/ValueSet/forms|4.0.1
    (example to http://hl7.org/fhir/ValueSet/forms|4.0.1)

    The forms codes.

    TypeCodeableConcept
    Is Modifierfalse
    Summaryfalse
    Requirements

    Needed to specify the specific form used for producing output for this response.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    88. ClaimResponse.form
    Definition

    The actual form, by reference or inclusion, for printing the content or an EOB.

    ShortPrinted reference or actual form
    Comments

    Needed to permit insurers to include the actual form.

    Control0..01
    TypeAttachment
    Is Modifierfalse
    Summaryfalse
    Requirements

    Needed to include the specific form used for producing output for this response.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    90. ClaimResponse.insurance
    Definition

    Financial instruments for reimbursement for the health care products and services specified on the claim.

    ShortPatient insurance information
    Comments

    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 'subrogation=false', should provide a reference to the ClaimResponse containing the adjudication results of the prior claim.

    Control0..0*
    TypeBackboneElement
    Is Modifierfalse
    Summaryfalse
    Requirements

    At least one insurer is required for a claim to be a claim.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    96. ClaimResponse.error
    Definition

    Errors encountered during the processing of the adjudication.

    ShortProcessing errors
    Comments

    If the request contains errors then an error element should be provided and no adjudication related sections (item, addItem, or payment) should be present.

    Control0..0*
    TypeBackboneElement
    Is Modifierfalse
    Summaryfalse
    Requirements

    Need to communicate processing issues to the requestor.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

    See the documentation on how to interpret the contents of this table

    0. ClaimResponse
    Invariantssa-cr-1: Where both are present, ClaimResponse.identifier (Approval Number) and ClaimResponse.preAuthRef SHALL carry the same value. ((identifier.exists() and preAuthRef.exists()) implies identifier.value contains preAuthRef)
    2. ClaimResponse.meta
    Control1..?
    4. ClaimResponse.meta.versionId
    Control0..0
    6. ClaimResponse.meta.lastUpdated
    ShortApproval version createdOn - orders versions by recency (D17)
    Control1..?
    Must Supporttrue
    8. ClaimResponse.extension
    Control1..?
    SlicingThis element introduces a set of slices on ClaimResponse.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

      10. ClaimResponse.extension:approvalDetail
      Slice NameapprovalDetail
      Control1..1
      TypeExtension(Approval Detail) (Complex Extension)
      Must Supporttrue
      12. ClaimResponse.extension:approvalCoverage
      Slice NameapprovalCoverage
      Control0..1
      TypeExtension(Approval Coverage) (Complex Extension)
      Must Supporttrue
      14. ClaimResponse.identifier
      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control1..1
      Must Supporttrue
      16. ClaimResponse.identifier.system
      Control1..?
      Fixed Value
      {
        "system" : "https://fhir-ig.digital.health.nz/special-authority/ns/approval-number"
      }
      <system value="https://fhir-ig.digital.health.nz/special-authority/ns/approval-number"/>
      18. ClaimResponse.identifier.value
      Control1..?
      20. ClaimResponse.status
      Comments

      Always active. The Approval status is carried in approval-detail.status.

      Pattern Value
      {
        "status" : "active"
      }
      <status value="active"/>
      22. ClaimResponse.type
      Pattern Value
      {
        "coding" : [
          {
            "system" : "http://terminology.hl7.org/CodeSystem/claim-type",
            "code" : "pharmacy"
          }
        ]
      }
      <type>
        <coding>
          <system value="http://terminology.hl7.org/CodeSystem/claim-type"/>
          <code value="pharmacy"/>
        </coding>
      </type>
      24. ClaimResponse.subType
      Control0..0
      26. ClaimResponse.use
      Pattern Value
      {
        "use" : "preauthorization"
      }
      <use value="preauthorization"/>
      28. ClaimResponse.patient
      TypeReference(SA Patient)
      Must Supporttrue
      30. ClaimResponse.created
      Must Supporttrue
      32. ClaimResponse.insurer
      Must Supporttrue
      34. ClaimResponse.insurer.reference
      Control0..0
      36. ClaimResponse.insurer.display
      Control1..?
      38. ClaimResponse.requestor
      ShortPrescribing Practitioner who authored the originating Application
      Control1..?
      TypeReference(SA Practitioner)
      Must Supporttrue
      40. ClaimResponse.request
      ShortThe originating Application, where still retrievable
      TypeReference(SA Claim)
      Must Supporttrue
      42. ClaimResponse.outcome
      Comments

      Always complete. Carries no HSAAP meaning.

      Pattern Value
      {
        "outcome" : "complete"
      }
      <outcome value="complete"/>
      44. ClaimResponse.preAuthRef
      Control1..?
      Must Supporttrue
      46. ClaimResponse.preAuthPeriod
      Control1..?
      Must Supporttrue
      48. ClaimResponse.preAuthPeriod.start
      Control1..?
      Must Supporttrue
      50. ClaimResponse.preAuthPeriod.end
      Control1..?
      Must Supporttrue
      52. ClaimResponse.payeeType
      Control0..0
      54. ClaimResponse.item
      Control0..0
      56. ClaimResponse.addItem
      Control0..0
      58. ClaimResponse.adjudication
      Control0..0
      60. ClaimResponse.total
      Control0..0
      62. ClaimResponse.payment
      Control0..0
      64. ClaimResponse.fundsReserve
      Control0..0
      66. ClaimResponse.formCode
      Control0..0
      68. ClaimResponse.form
      Control0..0
      70. ClaimResponse.insurance
      Control0..0
      72. ClaimResponse.error
      Control0..0

      See the documentation on how to interpret the contents of this table

      0. ClaimResponse
      Definition

      This resource provides the adjudication details from the processing of a Claim resource.

      ShortResponse to a claim predetermination or preauthorization
      Control0..*
      Is Modifierfalse
      Summaryfalse
      Alternate NamesRemittance Advice
      Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
      dom-3: 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 (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
      dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
      dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
      dom-6: A resource should have narrative for robust management (text.`div`.exists())
      sa-cr-1: Where both are present, ClaimResponse.identifier (Approval Number) and ClaimResponse.preAuthRef SHALL carry the same value. ((identifier.exists() and preAuthRef.exists()) implies identifier.value contains preAuthRef)
      2. ClaimResponse.id
      Definition

      The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

      ShortLogical id of this artifact
      Comments

      The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

      Control0..1
      Typeid
      Is Modifierfalse
      Summarytrue
      4. ClaimResponse.meta
      Definition

      The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

      ShortMetadata about the resource
      Control1..1
      TypeMeta
      Is Modifierfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      6. ClaimResponse.meta.id
      Definition

      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

      ShortUnique id for inter-element referencing
      Control0..1
      Typestring
      Is Modifierfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      8. ClaimResponse.meta.extension
      Definition

      May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

      ShortAdditional content defined by implementations
      Comments

      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

      Control0..*
      TypeExtension
      Is Modifierfalse
      Summaryfalse
      Alternate Namesextensions, user content
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      SlicingThis element introduces a set of slices on ClaimResponse.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 10. ClaimResponse.meta.versionId
        Definition

        The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

        ShortVersion specific identifier
        Comments

        The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

        Control0..0
        Typeid
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        12. ClaimResponse.meta.lastUpdated
        Definition

        When the resource last changed - e.g. when the version changed.

        ShortApproval version createdOn - orders versions by recency (D17)
        Comments

        This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

        Control1..1
        Typeinstant
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supporttrue
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        14. ClaimResponse.meta.source
        Definition

        A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.

        ShortIdentifies where the resource comes from
        Comments

        In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.

        This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

        Control0..1
        Typeuri
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        16. ClaimResponse.meta.profile
        Definition

        A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

        ShortProfiles this resource claims to conform to
        Comments

        It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

        Control0..*
        Typecanonical(StructureDefinition)
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        18. ClaimResponse.meta.security
        Definition

        Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

        ShortSecurity Labels applied to this resource
        Comments

        The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

        Control0..*
        BindingUnless not suitable, these codes SHALL be taken from All Security Labels
        (extensible to http://hl7.org/fhir/ValueSet/security-labels|4.0.1)

        Security Labels from the Healthcare Privacy and Security Classification System.

        TypeCoding
        Is Modifierfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        20. ClaimResponse.meta.tag
        Definition

        Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

        ShortTags applied to this resource
        Comments

        The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

        Control0..*
        BindingFor example codes, see CommonTags
        (example to http://hl7.org/fhir/ValueSet/common-tags|4.0.1)

        Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

        TypeCoding
        Is Modifierfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        22. ClaimResponse.implicitRules
        Definition

        A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

        ShortA set of rules under which this content was created
        Comments

        Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

        Control0..1
        Typeuri
        Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        24. ClaimResponse.language
        Definition

        The base language in which the resource is written.

        ShortLanguage of the resource content
        Comments

        Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

        Control0..1
        BindingThe codes SHOULD be taken from CommonLanguages
        (preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)

        A human language.

        Additional BindingsPurpose
        AllLanguagesMax Binding
        Typecode
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        26. ClaimResponse.text
        Definition

        A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

        ShortText summary of the resource, for human interpretation
        Comments

        Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

        Control0..1
        TypeNarrative
        Is Modifierfalse
        Summaryfalse
        Alternate Namesnarrative, html, xhtml, display
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        28. ClaimResponse.contained
        Definition

        These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

        ShortContained, inline Resources
        Comments

        This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

        Control0..*
        TypeResource
        Is Modifierfalse
        Summaryfalse
        Alternate Namesinline resources, anonymous resources, contained resources
        30. ClaimResponse.extension
        Definition

        An Extension

        ShortExtension
        Control1..*
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        SlicingThis element introduces a set of slices on ClaimResponse.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

          32. ClaimResponse.extension:approvalDetail
          Slice NameapprovalDetail
          Definition

          Approval facts that have no existing FHIR element, including the Approval status and the provider (pharmacy) identity (D16, D24). Approval status is carried here because ClaimResponse.status is bound to the financial resource status value set, which cannot express ACTIVE, CANCELLED or REVOKED.

          formNumber and formVersion are facts about the Approval. They deliberately do not reuse the Questionnaire.url|version canonical used for submission (D16).

          ShortApproval Detail
          Control1..1
          This element is affected by the following invariants: ele-1
          TypeExtension(Approval Detail) (Complex Extension)
          Is Modifierfalse
          Must Supporttrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          sa-detail-1: providerIdType and providerId are either both present or both absent. (extension('providerIdType').exists() = extension('providerId').exists())
          34. ClaimResponse.extension:approvalCoverage
          Slice NameapprovalCoverage
          Definition

          Coverage of an Approval, carried only for EXPLICIT_PHARMACEUTICALS, PRODUCT_CATEGORY and ALL_PHARMACEUTICALS (D15). Absent for SCHEDULE_HIERARCHY coverage: a standard CHEM/RISK Approval's coverage is re-derivable from approval-detail.formNumber and formVersion against the schedule (D6). NPPA and panel Approvals have no schedule form to derive coverage from, so their coverage is carried explicitly.

          ShortApproval Coverage
          Control0..1
          This element is affected by the following invariants: ele-1
          TypeExtension(Approval Coverage) (Complex Extension)
          Is Modifierfalse
          Must Supporttrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          sa-cov-1: pharmaceutical is present if, and only if, type is EXPLICIT_PHARMACEUTICALS. (extension('pharmaceutical').exists() = extension('type').where(value = 'EXPLICIT_PHARMACEUTICALS').exists())
          sa-cov-2: category is present if, and only if, type is PRODUCT_CATEGORY. (extension('category').exists() = extension('type').where(value = 'PRODUCT_CATEGORY').exists())
          36. ClaimResponse.modifierExtension
          Definition

          May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

          Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

          ShortExtensions that cannot be ignored
          Comments

          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

          Control0..*
          TypeExtension
          Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
          Summaryfalse
          Requirements

          Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

          Alternate Namesextensions, user content
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          38. ClaimResponse.identifier
          Definition

          A unique identifier assigned to this claim response.

          ShortBusiness Identifier for a claim response
          NoteThis is a business identifier, not a resource identifier (see discussion)
          Control1..1
          TypeIdentifier
          Is Modifierfalse
          Must Supporttrue
          Summaryfalse
          Requirements

          Allows claim responses to be distinguished and referenced.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          40. ClaimResponse.identifier.id
          Definition

          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

          ShortUnique id for inter-element referencing
          Control0..1
          Typestring
          Is Modifierfalse
          XML FormatIn the XML format, this property is represented as an attribute.
          Summaryfalse
          42. ClaimResponse.identifier.extension
          Definition

          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

          ShortAdditional content defined by implementations
          Comments

          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

          Control0..*
          TypeExtension
          Is Modifierfalse
          Summaryfalse
          Alternate Namesextensions, user content
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          SlicingThis element introduces a set of slices on ClaimResponse.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 44. ClaimResponse.identifier.use
            Definition

            The purpose of this identifier.

            Shortusual | official | temp | secondary | old (If known)
            Comments

            Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

            Control0..1
            BindingThe codes SHALL be taken from IdentifierUse
            (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

            Identifies the purpose for this identifier, if known .

            Typecode
            Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Requirements

            Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            46. ClaimResponse.identifier.type
            Definition

            A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

            ShortDescription of identifier
            Comments

            This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

            Control0..1
            BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codes
            (extensible to http://hl7.org/fhir/ValueSet/identifier-type|4.0.1)

            A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

            TypeCodeableConcept
            Is Modifierfalse
            Summarytrue
            Requirements

            Allows users to make use of identifiers when the identifier system is not known.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            48. ClaimResponse.identifier.system
            Definition

            Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

            ShortThe namespace for the identifier value
            Comments

            Identifier.system is always case sensitive.

            Control1..1
            Typeuri
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            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.

            Fixed Value
            {
              "system" : "https://fhir-ig.digital.health.nz/special-authority/ns/approval-number"
            }
            <system value="https://fhir-ig.digital.health.nz/special-authority/ns/approval-number"/>
            ExampleGeneral: http://www.acme.com/identifiers/patient
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            50. ClaimResponse.identifier.value
            Definition

            The portion of the identifier typically relevant to the user and which is unique within the context of the system.

            ShortThe value that is unique
            Comments

            If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. 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.

            Control1..1
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            ExampleGeneral: 123456
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            52. ClaimResponse.identifier.period
            Definition

            Time period during which identifier is/was valid for use.

            ShortTime period when id is/was valid for use
            Control0..1
            TypePeriod
            Is Modifierfalse
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            54. ClaimResponse.identifier.assigner
            Definition

            Organization that issued/manages the identifier.

            ShortOrganization that issued id (may be just text)
            Comments

            The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

            Control0..1
            TypeReference(Organization)
            Is Modifierfalse
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            56. ClaimResponse.status
            Definition

            The status of the resource instance.

            Shortactive | cancelled | draft | entered-in-error
            Comments

            Always active. The Approval status is carried in approval-detail.status.

            Control1..1
            BindingThe codes SHALL be taken from FinancialResourceStatusCodes
            (required to http://hl7.org/fhir/ValueSet/fm-status|4.0.1)

            A code specifying the state of the resource instance.

            Typecode
            Is Modifiertrue because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            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'.

            Pattern Value
            {
              "status" : "active"
            }
            <status value="active"/>
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            58. ClaimResponse.type
            Definition

            A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.

            ShortMore granular claim type
            Comments

            This may contain the local bill type codes, for example the US UB-04 bill type code or the CMS bill type.

            Control1..1
            BindingUnless not suitable, these codes SHALL be taken from ClaimTypeCodes
            (extensible to http://hl7.org/fhir/ValueSet/claim-type|4.0.1)

            The type or discipline-style of the claim.

            TypeCodeableConcept
            Is Modifierfalse
            Summarytrue
            Requirements

            Some jurisdictions need a finer grained claim type for routing and adjudication.

            Pattern Value
            {
              "coding" : [
                {
                  "system" : "http://terminology.hl7.org/CodeSystem/claim-type",
                  "code" : "pharmacy"
                }
              ]
            }
            <type>
              <coding>
                <system value="http://terminology.hl7.org/CodeSystem/claim-type"/>
                <code value="pharmacy"/>
              </coding>
            </type>
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            60. ClaimResponse.subType
            Definition

            A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.

            ShortMore granular claim type
            Comments

            This may contain the local bill type codes, for example the US UB-04 bill type code or the CMS bill type.

            Control0..0
            BindingFor example codes, see ExampleClaimSubTypeCodes
            (example to http://hl7.org/fhir/ValueSet/claim-subtype|4.0.1)

            A more granular claim typecode.

            TypeCodeableConcept
            Is Modifierfalse
            Summaryfalse
            Requirements

            Some jurisdictions need a finer grained claim type for routing and adjudication.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            62. ClaimResponse.use
            Definition

            A code to indicate whether the nature of the request is: to request adjudication of products and services previously rendered; or requesting authorization and adjudication for provision in the future; or requesting the non-binding adjudication of the listed products and services which could be provided in the future.

            Shortclaim | preauthorization | predetermination
            Control1..1
            BindingThe codes SHALL be taken from Use
            (required to http://hl7.org/fhir/ValueSet/claim-use|4.0.1)

            Claim, preauthorization, predetermination.

            Typecode
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Requirements

            This element is required to understand the nature of the request for adjudication.

            Pattern Value
            {
              "use" : "preauthorization"
            }
            <use value="preauthorization"/>
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            64. ClaimResponse.patient
            Definition

            The party to whom the professional services and/or products have been supplied or are being considered and for whom actual for facast reimbursement is sought.

            ShortThe recipient of the products and services
            Control1..1
            TypeReference(SA Patient)
            Is Modifierfalse
            Must Supporttrue
            Summarytrue
            Requirements

            The patient must be supplied to the insurer so that confirmation of coverage and service hstory may be considered as part of the authorization and/or adjudiction.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            66. ClaimResponse.created
            Definition

            The date this resource was created.

            ShortResponse creation date
            Control1..1
            TypedateTime
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supporttrue
            Summarytrue
            Requirements

            Need to record a timestamp for use by both the recipient and the issuer.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            68. ClaimResponse.insurer
            Definition

            The party responsible for authorization, adjudication and reimbursement.

            ShortParty responsible for reimbursement
            Control1..1
            TypeReference(Organization)
            Is Modifierfalse
            Must Supporttrue
            Summarytrue
            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.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            70. ClaimResponse.insurer.id
            Definition

            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

            ShortUnique id for inter-element referencing
            Control0..1
            Typestring
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            72. ClaimResponse.insurer.extension
            Definition

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            ShortAdditional content defined by implementations
            Comments

            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

            Control0..*
            TypeExtension
            Is Modifierfalse
            Summaryfalse
            Alternate Namesextensions, user content
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            SlicingThis element introduces a set of slices on ClaimResponse.insurer.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 74. ClaimResponse.insurer.reference
              Definition

              A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

              ShortLiteral reference, Relative, internal or absolute URL
              Comments

              Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

              Control0..0
              This element is affected by the following invariants: ref-1
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              76. ClaimResponse.insurer.type
              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).

              ShortType the reference refers to (e.g. "Patient")
              Comments

              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 RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

              Control0..1
              BindingUnless not suitable, these codes SHALL be taken from ResourceType
              (extensible to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)

              Aa resource (or, for logical models, the URI of the logical model).

              Typeuri
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              78. ClaimResponse.insurer.identifier
              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.

              ShortLogical reference, when literal reference is not known
              Comments

              When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

              When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

              Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

              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).

              NoteThis is a business identifier, not a resource identifier (see discussion)
              Control0..1
              TypeIdentifier
              Is Modifierfalse
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              80. ClaimResponse.insurer.display
              Definition

              Plain text narrative that identifies the resource in addition to the resource reference.

              ShortText alternative for the resource
              Comments

              This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

              Control1..1
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              82. ClaimResponse.requestor
              Definition

              The provider which is responsible for the claim, predetermination or preauthorization.

              ShortPrescribing Practitioner who authored the originating Application
              Comments

              Typically this field would be 1..1 where this party is responsible for the claim but not necessarily professionally responsible for the provision of the individual products and services listed below.

              Control1..1
              TypeReference(SA Practitioner)
              Is Modifierfalse
              Must Supporttrue
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              84. ClaimResponse.request
              Definition

              Original request resource reference.

              ShortThe originating Application, where still retrievable
              Control0..1
              TypeReference(SA Claim)
              Is Modifierfalse
              Must Supporttrue
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              86. ClaimResponse.outcome
              Definition

              The outcome of the claim, predetermination, or preauthorization processing.

              Shortqueued | complete | error | partial
              Comments

              Always complete. Carries no HSAAP meaning.

              Control1..1
              BindingThe codes SHALL be taken from ClaimProcessingCodes
              (required to http://hl7.org/fhir/ValueSet/remittance-outcome|4.0.1)

              The result of the claim processing.

              Typecode
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Requirements

              To advise the requestor of an overall processing outcome.

              Pattern Value
              {
                "outcome" : "complete"
              }
              <outcome value="complete"/>
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              88. ClaimResponse.disposition
              Definition

              A human readable description of the status of the adjudication.

              ShortDisposition Message
              Control0..1
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summaryfalse
              Requirements

              Provided for user display.

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              90. ClaimResponse.preAuthRef
              Definition

              Reference from the Insurer which is used in later communications which refers to this adjudication.

              ShortPreauthorization reference
              Comments

              This value is only present on preauthorization adjudications.

              Control1..1
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Must Supporttrue
              Summaryfalse
              Requirements

              On subsequent claims, the insurer may require the provider to quote this value.

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              92. ClaimResponse.preAuthPeriod
              Definition

              The time frame during which this authorization is effective.

              ShortPreauthorization reference effective period
              Control1..1
              TypePeriod
              Is Modifierfalse
              Must Supporttrue
              Summaryfalse
              Requirements

              To convey to the provider when the authorized products and services must be supplied for the authorized adjudication to apply.

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              94. ClaimResponse.preAuthPeriod.id
              Definition

              Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

              ShortUnique id for inter-element referencing
              Control0..1
              Typestring
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              96. ClaimResponse.preAuthPeriod.extension
              Definition

              May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

              ShortAdditional content defined by implementations
              Comments

              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

              Control0..*
              TypeExtension
              Is Modifierfalse
              Summaryfalse
              Alternate Namesextensions, user content
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              SlicingThis element introduces a set of slices on ClaimResponse.preAuthPeriod.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 98. ClaimResponse.preAuthPeriod.start
                Definition

                The start of the period. The boundary is inclusive.

                ShortStarting time with inclusive boundary
                Comments

                If the low element is missing, the meaning is that the low boundary is not known.

                Control1..1
                This element is affected by the following invariants: per-1
                TypedateTime
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Must Supporttrue
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                100. ClaimResponse.preAuthPeriod.end
                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.

                ShortEnd time with inclusive boundary, if not ongoing
                Comments

                The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.

                Control1..1
                This element is affected by the following invariants: per-1
                TypedateTime
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Must Supporttrue
                Summarytrue
                Meaning if MissingIf the end of the period is missing, it means that the period is ongoing
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                102. ClaimResponse.payeeType
                Definition

                Type of Party to be reimbursed: subscriber, provider, other.

                ShortParty to be paid any benefits payable
                Control0..0
                BindingFor example codes, see Claim Payee Type Codes
                (example to http://hl7.org/fhir/ValueSet/payeetype|4.0.1)

                A code for the party to be reimbursed.

                TypeCodeableConcept
                Is Modifierfalse
                Summaryfalse
                Requirements

                Need to know who should receive payment with the most common situations being the Provider (assignment of benefits) or the Subscriber.

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                104. ClaimResponse.item
                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.

                ShortAdjudication for claim line items
                Control0..0
                TypeBackboneElement
                Is Modifierfalse
                Summaryfalse
                Requirements

                The adjudication for items provided on the claim.

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                133. ClaimResponse.addItem
                Definition

                The first-tier service adjudications for payor added product or service lines.

                ShortInsurer added line items
                Control0..0
                TypeBackboneElement
                Is Modifierfalse
                Summaryfalse
                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.

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                179. ClaimResponse.adjudication
                Definition

                The adjudication results which are presented at the header level rather than at the line-item or add-item levels.

                ShortHeader-level adjudication
                Control0..0
                TypeSeettp://hl7.org/fhir/StructureDefinition/ClaimResponse#ClaimResponse.item.adjudication
                Is Modifierfalse
                Summaryfalse
                Requirements

                Some insurers will receive line-items but provide the adjudication only at a summary or header-level.

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                181. ClaimResponse.total
                Definition

                Categorized monetary totals for the adjudication.

                ShortAdjudication totals
                Comments

                Totals for amounts submitted, co-pays, benefits payable etc.

                Control0..0
                TypeBackboneElement
                Is Modifierfalse
                Summarytrue
                Requirements

                To provide the requestor with financial totals by category for the adjudication.

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                188. ClaimResponse.payment
                Definition

                Payment details for the adjudication of the claim.

                ShortPayment Details
                Control0..0
                TypeBackboneElement
                Is Modifierfalse
                Summaryfalse
                Requirements

                Needed to convey references to the financial instrument that has been used if payment has been made.

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                199. ClaimResponse.fundsReserve
                Definition

                A code, used only on a response to a preauthorization, to indicate whether the benefits payable have been reserved and for whom.

                ShortFunds reserved status
                Comments

                Fund would be release by a future claim quoting the preAuthRef of this response. Examples of values include: provider, patient, none.

                Control0..0
                BindingFor example codes, see Funds Reservation Codes
                (example to http://hl7.org/fhir/ValueSet/fundsreserve|4.0.1)

                For whom funds are to be reserved: (Patient, Provider, None).

                TypeCodeableConcept
                Is Modifierfalse
                Summaryfalse
                Requirements

                Needed to advise the submitting provider on whether the rquest for reservation of funds has been honored.

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                201. ClaimResponse.formCode
                Definition

                A code for the form to be used for printing the content.

                ShortPrinted form identifier
                Comments

                May be needed to identify specific jurisdictional forms.

                Control0..0
                BindingFor example codes, see Form Codes
                (example to http://hl7.org/fhir/ValueSet/forms|4.0.1)

                The forms codes.

                TypeCodeableConcept
                Is Modifierfalse
                Summaryfalse
                Requirements

                Needed to specify the specific form used for producing output for this response.

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                203. ClaimResponse.form
                Definition

                The actual form, by reference or inclusion, for printing the content or an EOB.

                ShortPrinted reference or actual form
                Comments

                Needed to permit insurers to include the actual form.

                Control0..0
                TypeAttachment
                Is Modifierfalse
                Summaryfalse
                Requirements

                Needed to include the specific form used for producing output for this response.

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                205. ClaimResponse.processNote
                Definition

                A note that describes or explains adjudication results in a human readable form.

                ShortNote concerning adjudication
                Control0..*
                TypeBackboneElement
                Is Modifierfalse
                Summaryfalse
                Requirements

                Provides the insurer specific textual explanations associated with the processing.

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                207. ClaimResponse.processNote.id
                Definition

                Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                ShortUnique id for inter-element referencing
                Control0..1
                Typestring
                Is Modifierfalse
                XML FormatIn the XML format, this property is represented as an attribute.
                Summaryfalse
                209. ClaimResponse.processNote.extension
                Definition

                May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                ShortAdditional content defined by implementations
                Comments

                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                Control0..*
                TypeExtension
                Is Modifierfalse
                Summaryfalse
                Alternate Namesextensions, user content
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                211. ClaimResponse.processNote.modifierExtension
                Definition

                May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                ShortExtensions that cannot be ignored even if unrecognized
                Comments

                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                Control0..*
                TypeExtension
                Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                Summarytrue
                Requirements

                Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                Alternate Namesextensions, user content, modifiers
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                213. ClaimResponse.processNote.number
                Definition

                A number to uniquely identify a note entry.

                ShortNote instance identifier
                Control0..1
                TypepositiveInt
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summaryfalse
                Requirements

                Necessary to provide a mechanism to link from adjudications.

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                215. ClaimResponse.processNote.type
                Definition

                The business purpose of the note text.

                Shortdisplay | print | printoper
                Control0..1
                BindingThe codes SHALL be taken from NoteType
                (required to http://hl7.org/fhir/ValueSet/note-type|4.0.1)

                The presentation types of notes.

                Typecode
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summaryfalse
                Requirements

                To convey the expectation for when the text is used.

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                217. ClaimResponse.processNote.text
                Definition

                The explanation or description associated with the processing.

                ShortNote explanatory text
                Control1..1
                Typestring
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summaryfalse
                Requirements

                Required to provide human readable explanation.

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                219. ClaimResponse.processNote.language
                Definition

                A code to define the language used in the text of the note.

                ShortLanguage of the text
                Comments

                Only required if the language is different from the resource language.

                Control0..1
                BindingThe codes SHOULD be taken from CommonLanguages
                (preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)

                A human language.

                Additional BindingsPurpose
                AllLanguagesMax Binding
                TypeCodeableConcept
                Is Modifierfalse
                Summaryfalse
                Requirements

                Note text may vary from the resource defined language.

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                221. ClaimResponse.communicationRequest
                Definition

                Request for additional supporting or authorizing information.

                ShortRequest for additional information
                Comments

                For example: professional reports, documents, images, clinical resources, or accident reports.

                Control0..*
                TypeReference(CommunicationRequest)
                Is Modifierfalse
                Summaryfalse
                Requirements

                Need to communicate insurer request for additional information required to support the adjudication.

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                223. ClaimResponse.insurance
                Definition

                Financial instruments for reimbursement for the health care products and services specified on the claim.

                ShortPatient insurance information
                Comments

                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 'subrogation=false', should provide a reference to the ClaimResponse containing the adjudication results of the prior claim.

                Control0..0
                TypeBackboneElement
                Is Modifierfalse
                Summaryfalse
                Requirements

                At least one insurer is required for a claim to be a claim.

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                233. ClaimResponse.error
                Definition

                Errors encountered during the processing of the adjudication.

                ShortProcessing errors
                Comments

                If the request contains errors then an error element should be provided and no adjudication related sections (item, addItem, or payment) should be present.

                Control0..0
                TypeBackboneElement
                Is Modifierfalse
                Summaryfalse
                Requirements

                Need to communicate processing issues to the requestor.

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))