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: SAClaim - Detailed Descriptions

Draft as of 2026-10-16

Definitions for the sa-claim resource profile.

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

0. Claim
Definition

A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reimbursement.

ShortClaim, Pre-determination or Pre-authorization
Comments

The Claim resource fulfills three information request requirements: Claim - a request for adjudication for reimbursement for products and/or services provided; Preauthorization - a request to authorize the future provision of products and/or services including an anticipated adjudication; and, Predetermination - a request for a non-bind adjudication of possible future products and/or services.

Control0..*
Is Modifierfalse
Summaryfalse
Alternate NamesAdjudication Request, Preauthorization Request, Predetermination Request
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())
2. Claim.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()))
4. Claim.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.

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

    6. Claim.extension:submissionContext
    Slice NamesubmissionContext
    Definition

    Asserted source context for a submission. This is provenance only: it MUST NOT override the authenticated identity, and MUST NOT be used for authentication or authorisation.

    The SOAP to FHIR Broker populates this from the legacy HL7 payload (ZSS.1, ZSL.1-ZSL.4, ZSU.1). Direct FHIR clients may omit it, in which case the API derives the values from the authenticated channel context.

    Note: the detailed design places this extension on Bundle. In FHIR R4 Bundle is a Resource, not a DomainResource, and cannot carry extensions, so this guide places it on the focal Claim. See Design Notes.

    ShortAsserted source context - provenance only
    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(Submission Context) (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())
    8. Claim.extension:applicationStatus
    Slice NameapplicationStatus
    Definition

    The HSAAP status and outcome of a Special Authority Application. The same shape is returned whether the status arrives synchronously from $submit or later through Application Enquiry (D22).

    Carried on ClaimResponse. It may also be carried on Claim in Application Enquiry results so that the application-status search parameter on Claim has an element to evaluate (see Design Notes).

    ShortPopulated by the API on Application Enquiry. SHALL NOT be sent on submission.
    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(Application Status) (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-appstatus-1: An outcome is present if, and only if, status is DONE. (extension('outcome').exists() = extension('status').where(value = 'DONE').exists())
    10. Claim.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())
    12. Claim.identifier
    Definition

    A unique identifier assigned to this claim.

    ShortApplication Number - populated by the API, absent on submissionBusiness Identifier for claim
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control0..1*
    TypeIdentifier
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Requirements

    Allows claims to be distinguished and referenced.

    Alternate NamesClaim Number
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    14. Claim.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()))
    16. Claim.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/application-number"
    }
    <system value="https://fhir-ig.digital.health.nz/special-authority/ns/application-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()))
    18. Claim.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()))
    20. Claim.status
    Definition

    The status of the resource instance.

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

    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()))
    22. Claim.type
    Definition

    The category of claim, e.g. oral, pharmacy, vision, institutional, professional.

    ShortCategory or discipline
    Comments

    The majority of jurisdictions use: oral, pharmacy, vision, professional and institutional, or variants on those terms, as the general styles of claims. The valueset is extensible to accommodate other jurisdictional requirements.

    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

    Claim type determine the general sets of business rules applied for information requirements 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()))
    24. Claim.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()))
    26. Claim.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)

    The purpose of the Claim: predetermination, preauthorization, claim.

    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()))
    28. Claim.patient
    Definition

    The party to whom the professional services and/or products have been supplied or are being considered and for whom actual or forecast 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 history 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()))
    30. Claim.billablePeriod
    Definition

    The period for which charges are being submitted.

    ShortRelevant time frame for the claim
    Comments

    Typically this would be today or in the past for a claim, and today or in the future for preauthorizations and predeterminations. Typically line item dates of service should fall within the billing period if one is specified.

    Control0..01
    TypePeriod
    Is Modifierfalse
    Summarytrue
    Requirements

    A number jurisdictions required the submission of the billing period when submitting claims for example for hospital stays or long-term care.

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

    The date this resource was created.

    ShortResource creation date
    Comments

    This field is independent of the date of creation of the resource as it may reflect the creation date of a source document prior to digitization. Typically for claims all services must be completed as of this 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()))
    34. Claim.enterer
    Definition

    Individual who created the claim, predetermination or preauthorization.

    ShortAuthor of the claim
    Control0..01
    TypeReference(Practitioner, PractitionerRole)
    Is Modifierfalse
    Summaryfalse
    Requirements

    Some jurisdictions require the contact information for personnel completing claims.

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

    The Insurer who is target of the request.

    ShortTarget
    Control0..01
    TypeReference(Organization)
    Is Modifierfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    38. Claim.provider
    Definition

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

    ShortThe Applicant - same Practitioner as QuestionnaireResponse.authorParty responsible for the claim
    Comments

    The detailed design refers to Claim.requestor, which does not exist in FHIR R4 Claim. Claim.provider ('the provider responsible for the preauthorization') is used instead. The custom 'requestor' search parameter on Claim evaluates Claim.provider so the API contract is preserved.


    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, Practitioner, PractitionerRole, Organization)
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    40. Claim.priority
    Definition

    The provider-required urgency of processing the request. Typical values include: stat, routine deferred.

    ShortDesired processing ugency
    Comments

    If a claim processor is unable to complete the processing as per the priority then they should generate and error and not process the request.

    Control1..1
    BindingFor example codes, see ProcessPriorityCodeshttp://hl7.org/fhir/ValueSet/process-priority|4.0.1
    (example to http://hl7.org/fhir/ValueSet/process-priority|4.0.1)

    The timeliness with which processing is required: stat, normal, deferred.

    TypeCodeableConcept
    Is Modifierfalse
    Summarytrue
    Requirements

    The provider may need to indicate their processing requirements so that the processor can indicate if they are unable to comply.

    Pattern Value
    {
      "coding" : [
        {
          "system" : "http://terminology.hl7.org/CodeSystem/processpriority",
          "code" : "normal"
        }
      ]
    }
    <priority>
      <coding>
        <system value="http://terminology.hl7.org/CodeSystem/processpriority"/>
        <code value="normal"/>
      </coding>
    </priority>
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    42. Claim.fundsReserve
    Definition

    A code to indicate whether and for whom funds are to be reserved for future claims.

    ShortFor whom to reserve funds
    Comments

    This field is only used for preauthorizations.

    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

    In the case of a Pre-Determination/Pre-Authorization the provider may request that funds in the amount of the expected Benefit be reserved ('Patient' or 'Provider') to pay for the Benefits determined on the subsequent claim(s). 'None' explicitly indicates no funds reserving is requested.

    Alternate NamesFund pre-allocation
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    44. Claim.related
    Definition

    Other claims which are related to this claim such as prior submissions or claims for related services or for the same event.

    ShortPrior or corollary claims
    Comments

    For example, for the original treatment and follow-up exams.

    Control0..0*
    TypeBackboneElement
    Is Modifierfalse
    Summaryfalse
    Requirements

    For workplace or other accidents it is common to relate separate claims arising from the same event.

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

    Prescription to support the dispensing of pharmacy, device or vision products.

    ShortPrescription authorizing services and products
    Control0..01
    TypeReference(DeviceRequest, MedicationRequest, VisionPrescription)
    Is Modifierfalse
    Summaryfalse
    Requirements

    Required to authorize the dispensing of controlled substances and devices.

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

    Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products.

    ShortOriginal prescription if superseded by fulfiller
    Comments

    For example, a physician may prescribe a medication which the pharmacy determines is contraindicated, or for which the patient has an intolerance, and therefore issues a new prescription for an alternate medication which has the same therapeutic intent. The prescription from the pharmacy becomes the 'prescription' and that from the physician becomes the 'original prescription'.

    Control0..01
    TypeReference(DeviceRequest, MedicationRequest, VisionPrescription)
    Is Modifierfalse
    Summaryfalse
    Requirements

    Often required when a fulfiller varies what is fulfilled from that authorized on the original prescription.

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

    The party to be reimbursed for cost of the products and services according to the terms of the policy.

    ShortRecipient of benefits payable
    Comments

    Often providers agree to receive the benefits payable to reduce the near-term costs to the patient. The insurer may decline to pay the provider and choose to pay the subscriber instead.

    Control0..01
    TypeBackboneElement
    Is Modifierfalse
    Summaryfalse
    Requirements

    The provider needs to specify who they wish to be reimbursed and the claims processor needs express who they will reimburse.

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

    A reference to a referral resource.

    ShortTreatment referral
    Comments

    The referrer is carried by the referring-practitioner extension on the QuestionnaireResponse.


    The referral resource which lists the date, practitioner, reason and other supporting information.

    Control0..01
    TypeReference(ServiceRequest)
    Is Modifierfalse
    Summaryfalse
    Requirements

    Some insurers require proof of referral to pay for services or to pay specialist rates for services.

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

    Facility where the services were provided.

    ShortServicing facility
    Control0..01
    TypeReference(Location)
    Is Modifierfalse
    Summaryfalse
    Requirements

    Insurance adjudication can be dependant on where services were delivered.

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

    The members of the team who provided the products and services.

    ShortMembers of the care team
    Control0..0*
    TypeBackboneElement
    Is Modifierfalse
    Summaryfalse
    Requirements

    Common to identify the responsible and supporting practitioners.

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

    Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues.

    ShortSupporting information
    Comments

    Often there are multiple jurisdiction specific valuesets which are required.

    Control10..*
    TypeBackboneElement
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Requirements

    Typically these information codes are required to support the services rendered or the adjudication of the services rendered.

    Alternate NamesAttachments Exception Codes Occurrence Codes Value codes
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    SlicingThis element introduces a set of slices on Claim.supportingInfo. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • pattern @ category
    • Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

      66. Claim.supportingInfo.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())
      68. Claim.supportingInfo.sequence
      Definition

      A number to uniquely identify supporting information entries.

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

      Necessary to maintain the order of the supporting information items and provide a mechanism to link to claim details.

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

      The general class of the information supplied: information; exception; accident, employment; onset, etc.

      ShortClassification of the supplied information
      Comments

      This may contain a category for the local bill type codes.

      Control1..1
      BindingFor example codes, see ClaimInformationCategoryCodeshttp://hl7.org/fhir/ValueSet/claim-informationcategory|4.0.1
      (example to http://hl7.org/fhir/ValueSet/claim-informationcategory|4.0.1)

      The valuset used for additional information category codes.

      TypeCodeableConcept
      Is Modifierfalse
      Summaryfalse
      Requirements

      Required to group or associate information items with common characteristics. For example: admission information or prior treatments.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      72. Claim.supportingInfo:questionnaireResponse
      Slice NamequestionnaireResponse
      Definition

      Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues.

      ShortSupporting information
      Comments

      Often there are multiple jurisdiction specific valuesets which are required.

      Control10..1*
      TypeBackboneElement
      Is Modifierfalse
      Must Supporttrue
      Summaryfalse
      Requirements

      Typically these information codes are required to support the services rendered or the adjudication of the services rendered.

      Alternate NamesAttachments Exception Codes Occurrence Codes Value codes
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      74. Claim.supportingInfo:questionnaireResponse.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())
      76. Claim.supportingInfo:questionnaireResponse.sequence
      Definition

      A number to uniquely identify supporting information entries.

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

      Necessary to maintain the order of the supporting information items and provide a mechanism to link to claim details.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      78. Claim.supportingInfo:questionnaireResponse.category
      Definition

      The general class of the information supplied: information; exception; accident, employment; onset, etc.

      ShortClassification of the supplied information
      Comments

      This may contain a category for the local bill type codes.

      Control1..1
      BindingFor example codes, see ClaimInformationCategoryCodeshttp://hl7.org/fhir/ValueSet/claim-informationcategory|4.0.1
      (example to http://hl7.org/fhir/ValueSet/claim-informationcategory|4.0.1)

      The valuset used for additional information category codes.

      TypeCodeableConcept
      Is Modifierfalse
      Summaryfalse
      Requirements

      Required to group or associate information items with common characteristics. For example: admission information or prior treatments.

      Pattern Value
      {
        "coding" : [
          {
            "system" : "https://fhir-ig.digital.health.nz/special-authority/CodeSystem/sa-supporting-info-category",
            "code" : "questionnaire-response"
          }
        ]
      }
      <category>
        <coding>
          <system value="https://fhir-ig.digital.health.nz/special-authority/CodeSystem/sa-supporting-info-category"/>
          <code value="questionnaire-response"/>
        </coding>
      </category>
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      80. Claim.supportingInfo:questionnaireResponse.value[x]
      Definition

      Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.

      ShortData to be provided
      Comments

      Could be used to provide references to other resources, document. For example could contain a PDF in an Attachment of the Police Report for an Accident.

      Control10..1
      TypeReference(SA QuestionnaireResponse, Resource), boolean, string, Quantity, Attachment
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Is Modifierfalse
      Must Supporttrue
      Summaryfalse
      Requirements

      To convey the data content to be provided when the information is more than a simple code or period.

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

      Information about diagnoses relevant to the claim items.

      ShortPertinent diagnosis information
      Control0..0*
      TypeBackboneElement
      Is Modifierfalse
      Summaryfalse
      Requirements

      Required for the adjudication by provided context for the services and product listed.

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

      Procedures performed on the patient relevant to the billing items with the claim.

      ShortClinical procedures performed
      Control0..0*
      TypeBackboneElement
      Is Modifierfalse
      Summaryfalse
      Requirements

      The specific clinical invention are sometimes required to be provided to justify billing a greater than customary amount for a service.

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

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

      ShortMandatory in FHIR R4 - logical reference to the Pharmaceutical Schedule onlyPatient 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 'Coverage.subrogation=false', should provide a reference to the ClaimResponse containing the adjudication results of the prior claim.

      Control1..1*
      TypeBackboneElement
      Is Modifierfalse
      Summarytrue
      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()))
      94. Claim.insurance.modifierExtension
      Definition

      May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element 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())
      96. Claim.insurance.sequence
      Definition

      A number to uniquely identify insurance entries and provide a sequence of coverages to convey coordination of benefit order.

      ShortInsurance instance identifier
      Control1..1
      TypepositiveInt
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      To maintain order of the coverages.

      Pattern Value
      {
        "sequence" : 1
      }
      <sequence value="1"/>
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      98. Claim.insurance.focal
      Definition

      A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true.

      ShortCoverage to be used for adjudication
      Comments

      A patient may (will) have multiple insurance policies which provide reimbursement for healthcare services and products. For example a person may also be covered by their spouse's policy and both appear in the list (and may be from the same insurer). This flag will be set to true for only one of the listed policies and that policy will be used for adjudicating this claim. Other claims would be created to request adjudication against the other listed policies.

      Control1..1
      Typeboolean
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      To identify which coverage in the list is being used to adjudicate this claim.

      Fixed Value
      {
        "focal" : true
      }
      <focal value="true"/>
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      100. Claim.insurance.identifier
      Definition

      The business identifier to be used when the claim is sent for adjudication against this insurance policy.

      ShortPre-assigned Claim number
      Comments

      Only required in jurisdictions where insurers, rather than the provider, are required to send claims to insurers that appear after them in the list. This element is not required when 'subrogation=true'.

      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control0..01
      TypeIdentifier
      Is Modifierfalse
      Summaryfalse
      Requirements

      This will be the claim number should it be necessary to create this claim in the future. This is provided so that payors may forward claims to other payors in the Coordination of Benefit for adjudication rather than the provider being required to initiate each adjudication.

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

      Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system.

      ShortInsurance information
      Control1..1
      TypeReference(Coverage)
      Is Modifierfalse
      Summarytrue
      Requirements

      Required to allow the adjudicator to locate the correct policy and history within their information system.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      104. Claim.insurance.coverage.reference
      Definition

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

      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()))
      106. Claim.insurance.coverage.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
      Pattern Value
      {
        "display" : "Pharmaceutical Schedule"
      }
      <display value="Pharmaceutical Schedule"/>
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      108. Claim.insurance.businessArrangement
      Definition

      A business agreement number established between the provider and the insurer for special business processing purposes.

      ShortAdditional provider contract number
      Control0..01
      Typestring
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summaryfalse
      Requirements

      Providers may have multiple business arrangements with a given insurer and must supply the specific contract number for adjudication.

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

      Reference numbers previously provided by the insurer to the provider to be quoted on subsequent claims containing services or products related to the prior authorization.

      ShortPrior authorization reference number
      Comments

      This value is an alphanumeric string that may be provided over the phone, via text, via paper, or within a ClaimResponse resource and is not a FHIR Identifier.

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

      Providers must quote previously issued authorization reference numbers in order to obtain adjudication as previously advised on the Preauthorization.

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

      The result of the adjudication of the line items for the Coverage specified in this insurance.

      ShortAdjudication results
      Comments

      Must not be specified when 'focal=true' for this insurance.

      Control0..01
      TypeReference(ClaimResponse)
      Is Modifierfalse
      Summaryfalse
      Requirements

      An insurer need the adjudication results from prior insurers to determine the outstanding balance remaining by item for the items in the curent claim.

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

      Details of an accident which resulted in injuries which required the products and services listed in the claim.

      ShortDetails of the event
      Control0..01
      TypeBackboneElement
      Is Modifierfalse
      Summaryfalse
      Requirements

      When healthcare products and services are accident related, benefits may be payable under accident provisions of policies, such as automotive, etc before they are payable under normal health insurance.

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

      A claim line. Either a simple product or service or a 'group' of details which can each be a simple items or groups of sub-details.

      ShortRequested pharmaceuticals - NPPA and panel approval Applications onlyProduct or service provided
      Control0..*
      TypeBackboneElement
      Is Modifierfalse
      Must Supporttrue
      Summaryfalse
      Requirements

      The items to be processed for adjudication.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      sa-claim-1: A requested pharmaceutical SHALL be identified by a CTPP ID or a Pharmacode. (productOrService.coding.where(system = 'http://nzmt.org.nz' or system = 'https://fhir-ig.digital.health.nz/special-authority/ns/pharmacode').exists())
      120. Claim.item.modifierExtension
      Definition

      May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element 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())
      122. Claim.item.sequence
      Definition

      A number to uniquely identify item entries.

      ShortItem instance identifier
      Control1..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 to items from within the claim and within the adjudication details of the ClaimResponse.

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

      CareTeam members related to this service or product.

      ShortApplicable careTeam members
      Control0..0*
      TypepositiveInt
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summaryfalse
      Requirements

      Need to identify the individuals and their roles in the provision of the product or service.

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

      Diagnosis applicable for this service or product.

      ShortApplicable diagnoses
      Control0..0*
      TypepositiveInt
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summaryfalse
      Requirements

      Need to related the product or service to the associated diagnoses.

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

      Procedures applicable for this service or product.

      ShortApplicable procedures
      Control0..0*
      TypepositiveInt
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summaryfalse
      Requirements

      Need to provide any listed specific procedures to support the product or service being claimed.

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

      Exceptions, special conditions and supporting information applicable for this service or product.

      ShortApplicable exception and supporting information
      Control0..0*
      TypepositiveInt
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summaryfalse
      Requirements

      Need to reference the supporting information items that relate directly to this product or service.

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

      The type of revenue or cost center providing the product and/or service.

      ShortRevenue or cost center code
      Control0..01
      BindingFor example codes, see ExampleRevenueCenterCodeshttp://hl7.org/fhir/ValueSet/ex-revenue-center|4.0.1
      (example to http://hl7.org/fhir/ValueSet/ex-revenue-center|4.0.1)

      Codes for the revenue or cost centers supplying the service and/or products.

      TypeCodeableConcept
      Is Modifierfalse
      Summaryfalse
      Requirements

      Needed in the processing of institutional claims.

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

      Code to identify the general type of benefits under which products and services are provided.

      ShortBenefit classification
      Comments

      Examples include Medical Care, Periodontics, Renal Dialysis, Vision Coverage.

      Control0..01
      BindingFor example codes, see BenefitCategoryCodeshttp://hl7.org/fhir/ValueSet/ex-benefitcategory|4.0.1
      (example to http://hl7.org/fhir/ValueSet/ex-benefitcategory|4.0.1)

      Benefit categories such as: oral-basic, major, glasses.

      TypeCodeableConcept
      Is Modifierfalse
      Summaryfalse
      Requirements

      Needed in the processing of institutional claims as this allows the insurer to determine whether a facial X-Ray is for dental, orthopedic, or facial surgery purposes.

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

      When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.

      ShortBilling, service, product, or drug code
      Comments

      If this is an actual service or product line, i.e. not a Group, then use code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS, USCLS, ICD10, NCPDP, DIN, RxNorm, ACHI, CCI). If a grouping item then use a group code to indicate the type of thing being grouped e.g. 'glasses' or 'compound'.

      Control1..1
      BindingFor example codes, see USCLSCodeshttp://hl7.org/fhir/ValueSet/service-uscls|4.0.1
      (example to http://hl7.org/fhir/ValueSet/service-uscls|4.0.1)

      Allowable service and product codes.

      TypeCodeableConcept
      Is Modifierfalse
      Must Supporttrue
      Summaryfalse
      Requirements

      Necessary to state what was provided or done.

      Alternate NamesDrug Code, Bill Code, Service Code
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      138. Claim.item.productOrService.coding
      Definition

      A reference to a code defined by a terminology system.

      ShortCode defined by a terminology system
      Comments

      Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

      Control10..*
      TypeCoding
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Requirements

      Allows for alternative encodings within a code system, and translations to other code systems.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      SlicingThis element introduces a set of slices on Claim.item.productOrService.coding. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ system
      • Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

        140. Claim.item.productOrService.coding:ctpp
        Slice Namectpp
        Definition

        A reference to a code defined by a terminology system.

        ShortNZMT CTPP ID (preferred)Code defined by a terminology system
        Comments

        Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

        Control0..1*
        TypeCoding
        Is Modifierfalse
        Must Supporttrue
        Summarytrue
        Requirements

        Allows for alternative encodings within a code system, and translations to other code systems.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        142. Claim.item.productOrService.coding:ctpp.system
        Definition

        The identification of the code system that defines the meaning of the symbol in the code.

        ShortIdentity of the terminology system
        Comments

        The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

        Control10..1
        Typeuri
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Requirements

        Need to be unambiguous about the source of the definition of the symbol.

        Fixed Value
        {
          "system" : "http://nzmt.org.nz"
        }
        <system value="http://nzmt.org.nz"/>
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        144. Claim.item.productOrService.coding:ctpp.code
        Definition

        A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

        ShortSymbol in syntax defined by the system
        Control10..1
        Typecode
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Requirements

        Need to refer to a particular code in the system.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        146. Claim.item.productOrService.coding:ctpp.display
        Definition

        A representation of the meaning of the code in the system, following the rules of the system.

        ShortRepresentation defined by the system
        Control0..1
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supporttrue
        Summarytrue
        Requirements

        Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        148. Claim.item.productOrService.coding:pharmacode
        Slice Namepharmacode
        Definition

        A reference to a code defined by a terminology system.

        ShortPharmac PharmacodeCode defined by a terminology system
        Comments

        Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

        Control0..1*
        TypeCoding
        Is Modifierfalse
        Must Supporttrue
        Summarytrue
        Requirements

        Allows for alternative encodings within a code system, and translations to other code systems.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        150. Claim.item.productOrService.coding:pharmacode.system
        Definition

        The identification of the code system that defines the meaning of the symbol in the code.

        ShortIdentity of the terminology system
        Comments

        The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

        Control10..1
        Typeuri
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Requirements

        Need to be unambiguous about the source of the definition of the symbol.

        Fixed Value
        {
          "system" : "https://fhir-ig.digital.health.nz/special-authority/ns/pharmacode"
        }
        <system value="https://fhir-ig.digital.health.nz/special-authority/ns/pharmacode"/>
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        152. Claim.item.productOrService.coding:pharmacode.code
        Definition

        A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

        ShortSymbol in syntax defined by the system
        Control10..1
        Typecode
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Requirements

        Need to refer to a particular code in the system.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        154. Claim.item.productOrService.coding:pharmacode.display
        Definition

        A representation of the meaning of the code in the system, following the rules of the system.

        ShortRepresentation defined by the system
        Control0..1
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supporttrue
        Summarytrue
        Requirements

        Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

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

        Item typification or modifiers codes to convey additional context for the product or service.

        ShortProduct or service billing modifiers
        Comments

        For example in Oral whether the treatment is cosmetic or associated with TMJ, or for Medical whether the treatment was outside the clinic or outside of office hours.

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

        Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.

        TypeCodeableConcept
        Is Modifierfalse
        Summaryfalse
        Requirements

        To support inclusion of the item for adjudication or to charge an elevated fee.

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

        Identifies the program under which this may be recovered.

        ShortProgram the product or service is provided under
        Comments

        For example: Neonatal program, child dental program or drug users recovery program.

        Control0..0*
        BindingFor example codes, see ExampleProgramReasonCodeshttp://hl7.org/fhir/ValueSet/ex-program-code|4.0.1
        (example to http://hl7.org/fhir/ValueSet/ex-program-code|4.0.1)

        Program specific reason codes.

        TypeCodeableConcept
        Is Modifierfalse
        Summaryfalse
        Requirements

        Commonly used in in the identification of publicly provided program focused on population segments or disease classifications.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        160. Claim.item.serviced[x]
        Definition

        The date or dates when the service or product was supplied, performed or completed.

        ShortDate or dates of service or product delivery
        Control0..01
        TypeChoice of: date, Period
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summaryfalse
        Requirements

        Needed to determine whether the service or product was provided during the term of the insurance coverage.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        162. Claim.item.location[x]
        Definition

        Where the product or service was provided.

        ShortPlace of service or where product was supplied
        Control0..01
        BindingFor example codes, see ExampleServicePlaceCodeshttp://hl7.org/fhir/ValueSet/service-place|4.0.1
        (example to http://hl7.org/fhir/ValueSet/service-place|4.0.1)

        Place of service: pharmacy, school, prison, etc.

        TypeChoice of: CodeableConcept, Address, Reference(Location)
        Is Modifierfalse
        Summaryfalse
        Requirements

        The location can alter whether the item was acceptable for insurance purposes or impact the determination of the benefit amount.

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

        If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.

        ShortFee, charge or cost per item
        Control0..01
        TypeMoney
        Is Modifierfalse
        Summaryfalse
        Requirements

        The amount charged to the patient by the provider for a single unit.

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

        A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

        ShortPrice scaling factor
        Comments

        To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10).

        Control0..01
        Typedecimal
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summaryfalse
        Requirements

        When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication.

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

        The quantity times the unit price for an additional service or product or charge.

        ShortTotal item cost
        Comments

        For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.

        Control0..01
        TypeMoney
        Is Modifierfalse
        Summaryfalse
        Requirements

        Provides the total amount claimed for the group (if a grouper) or the line item.

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

        Unique Device Identifiers associated with this line item.

        ShortUnique device identifier
        Control0..0*
        TypeReference(Device)
        Is Modifierfalse
        Summaryfalse
        Requirements

        The UDI code allows the insurer to obtain device level information on the product supplied.

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

        Physical service site on the patient (limb, tooth, etc.).

        ShortAnatomical location
        Comments

        For example: Providing a tooth code, allows an insurer to identify a provider performing a filling on a tooth that was previously removed.

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

        The code for the teeth, quadrant, sextant and arch.

        TypeCodeableConcept
        Is Modifierfalse
        Summaryfalse
        Requirements

        Allows insurer to validate specific procedures.

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

        A region or surface of the bodySite, e.g. limb region or tooth surface(s).

        ShortAnatomical sub-location
        Control0..0*
        BindingFor example codes, see SurfaceCodeshttp://hl7.org/fhir/ValueSet/surface|4.0.1
        (example to http://hl7.org/fhir/ValueSet/surface|4.0.1)

        The code for the tooth surface and surface combinations.

        TypeCodeableConcept
        Is Modifierfalse
        Summaryfalse
        Requirements

        Allows insurer to validate specific procedures.

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

        The Encounters during which this Claim was created or to which the creation of this record is tightly associated.

        ShortEncounters related to this billed item
        Comments

        This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter.

        Control0..0*
        TypeReference(Encounter)
        Is Modifierfalse
        Summaryfalse
        Requirements

        Used in some jurisdictions to link clinical events to claim items.

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

        A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items.

        ShortProduct or service provided
        Control0..0*
        TypeBackboneElement
        Is Modifierfalse
        Summaryfalse
        Requirements

        The items to be processed for adjudication.

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

        The total value of the all the items in the claim.

        ShortTotal claim cost
        Control0..01
        TypeMoney
        Is Modifierfalse
        Summaryfalse
        Requirements

        Used for control total purposes.

        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. Claim
        2. Claim.extension
        SlicingThis element introduces a set of slices on Claim.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

          4. Claim.extension:submissionContext
          Slice NamesubmissionContext
          ShortAsserted source context - provenance only
          Control0..1
          TypeExtension(Submission Context) (Complex Extension)
          Must Supporttrue
          6. Claim.extension:applicationStatus
          Slice NameapplicationStatus
          ShortPopulated by the API on Application Enquiry. SHALL NOT be sent on submission.
          Control0..1
          TypeExtension(Application Status) (Complex Extension)
          Must Supporttrue
          8. Claim.identifier
          ShortApplication Number - populated by the API, absent on submission
          NoteThis is a business identifier, not a resource identifier (see discussion)
          Control0..1
          Must Supporttrue
          10. Claim.identifier.system
          Control1..?
          Fixed Value
          {
            "system" : "https://fhir-ig.digital.health.nz/special-authority/ns/application-number"
          }
          <system value="https://fhir-ig.digital.health.nz/special-authority/ns/application-number"/>
          12. Claim.identifier.value
          Control1..?
          14. Claim.status
          Pattern Value
          {
            "status" : "active"
          }
          <status value="active"/>
          16. Claim.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>
          18. Claim.subType
          Control0..0
          20. Claim.use
          Pattern Value
          {
            "use" : "preauthorization"
          }
          <use value="preauthorization"/>
          22. Claim.patient
          TypeReference(SA Patient)
          Must Supporttrue
          24. Claim.billablePeriod
          Control0..0
          26. Claim.created
          Must Supporttrue
          28. Claim.enterer
          Control0..0
          30. Claim.insurer
          Control0..0
          32. Claim.provider
          ShortThe Applicant - same Practitioner as QuestionnaireResponse.author
          Comments

          The detailed design refers to Claim.requestor, which does not exist in FHIR R4 Claim. Claim.provider ('the provider responsible for the preauthorization') is used instead. The custom 'requestor' search parameter on Claim evaluates Claim.provider so the API contract is preserved.

          TypeReference(SA Practitioner)
          Must Supporttrue
          34. Claim.priority
          Pattern Value
          {
            "coding" : [
              {
                "system" : "http://terminology.hl7.org/CodeSystem/processpriority",
                "code" : "normal"
              }
            ]
          }
          <priority>
            <coding>
              <system value="http://terminology.hl7.org/CodeSystem/processpriority"/>
              <code value="normal"/>
            </coding>
          </priority>
          36. Claim.fundsReserve
          Control0..0
          38. Claim.related
          Control0..0
          40. Claim.prescription
          Control0..0
          42. Claim.originalPrescription
          Control0..0
          44. Claim.payee
          Control0..0
          46. Claim.referral
          Comments

          The referrer is carried by the referring-practitioner extension on the QuestionnaireResponse.

          Control0..0
          48. Claim.facility
          Control0..0
          50. Claim.careTeam
          Control0..0
          52. Claim.supportingInfo
          Control1..?
          Must Supporttrue
          SlicingThis element introduces a set of slices on Claim.supportingInfo. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • pattern @ category
          • Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

            54. Claim.supportingInfo:questionnaireResponse
            Slice NamequestionnaireResponse
            Control1..1
            Must Supporttrue
            56. Claim.supportingInfo:questionnaireResponse.category
            Pattern Value
            {
              "coding" : [
                {
                  "system" : "https://fhir-ig.digital.health.nz/special-authority/CodeSystem/sa-supporting-info-category",
                  "code" : "questionnaire-response"
                }
              ]
            }
            <category>
              <coding>
                <system value="https://fhir-ig.digital.health.nz/special-authority/CodeSystem/sa-supporting-info-category"/>
                <code value="questionnaire-response"/>
              </coding>
            </category>
            58. Claim.supportingInfo:questionnaireResponse.value[x]
            Control1..?
            TypeReference(SA QuestionnaireResponse)
            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
            Must Supporttrue
            60. Claim.diagnosis
            Control0..0
            62. Claim.procedure
            Control0..0
            64. Claim.insurance
            ShortMandatory in FHIR R4 - logical reference to the Pharmaceutical Schedule only
            Control0..1
            66. Claim.insurance.sequence
            Pattern Value
            {
              "sequence" : 1
            }
            <sequence value="1"/>
            68. Claim.insurance.focal
            Fixed Value
            {
              "focal" : true
            }
            <focal value="true"/>
            70. Claim.insurance.identifier
            NoteThis is a business identifier, not a resource identifier (see discussion)
            Control0..0
            72. Claim.insurance.coverage
            74. Claim.insurance.coverage.reference
            Control0..0
            76. Claim.insurance.coverage.display
            Control1..?
            Pattern Value
            {
              "display" : "Pharmaceutical Schedule"
            }
            <display value="Pharmaceutical Schedule"/>
            78. Claim.insurance.businessArrangement
            Control0..0
            80. Claim.insurance.preAuthRef
            Control0..0
            82. Claim.insurance.claimResponse
            Control0..0
            84. Claim.accident
            Control0..0
            86. Claim.item
            ShortRequested pharmaceuticals - NPPA and panel approval Applications only
            Must Supporttrue
            Invariantssa-claim-1: A requested pharmaceutical SHALL be identified by a CTPP ID or a Pharmacode. (productOrService.coding.where(system = 'http://nzmt.org.nz' or system = 'https://fhir-ig.digital.health.nz/special-authority/ns/pharmacode').exists())
            88. Claim.item.careTeamSequence
            Control0..0
            90. Claim.item.diagnosisSequence
            Control0..0
            92. Claim.item.procedureSequence
            Control0..0
            94. Claim.item.informationSequence
            Control0..0
            96. Claim.item.revenue
            Control0..0
            98. Claim.item.category
            Control0..0
            100. Claim.item.productOrService
            Must Supporttrue
            102. Claim.item.productOrService.coding
            Control1..?
            Must Supporttrue
            SlicingThis element introduces a set of slices on Claim.item.productOrService.coding. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ system
            • Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

              104. Claim.item.productOrService.coding:ctpp
              Slice Namectpp
              ShortNZMT CTPP ID (preferred)
              Control0..1
              Must Supporttrue
              106. Claim.item.productOrService.coding:ctpp.system
              Control1..?
              Fixed Value
              {
                "system" : "http://nzmt.org.nz"
              }
              <system value="http://nzmt.org.nz"/>
              108. Claim.item.productOrService.coding:ctpp.code
              Control1..?
              110. Claim.item.productOrService.coding:ctpp.display
              Must Supporttrue
              112. Claim.item.productOrService.coding:pharmacode
              Slice Namepharmacode
              ShortPharmac Pharmacode
              Control0..1
              Must Supporttrue
              114. Claim.item.productOrService.coding:pharmacode.system
              Control1..?
              Fixed Value
              {
                "system" : "https://fhir-ig.digital.health.nz/special-authority/ns/pharmacode"
              }
              <system value="https://fhir-ig.digital.health.nz/special-authority/ns/pharmacode"/>
              116. Claim.item.productOrService.coding:pharmacode.code
              Control1..?
              118. Claim.item.productOrService.coding:pharmacode.display
              Must Supporttrue
              120. Claim.item.modifier
              Control0..0
              122. Claim.item.programCode
              Control0..0
              124. Claim.item.serviced[x]
              Control0..0
              126. Claim.item.location[x]
              Control0..0
              128. Claim.item.unitPrice
              Control0..0
              130. Claim.item.factor
              Control0..0
              132. Claim.item.net
              Control0..0
              134. Claim.item.udi
              Control0..0
              136. Claim.item.bodySite
              Control0..0
              138. Claim.item.subSite
              Control0..0
              140. Claim.item.encounter
              Control0..0
              142. Claim.item.detail
              Control0..0
              144. Claim.total
              Control0..0

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

              0. Claim
              Definition

              A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reimbursement.

              ShortClaim, Pre-determination or Pre-authorization
              Comments

              The Claim resource fulfills three information request requirements: Claim - a request for adjudication for reimbursement for products and/or services provided; Preauthorization - a request to authorize the future provision of products and/or services including an anticipated adjudication; and, Predetermination - a request for a non-bind adjudication of possible future products and/or services.

              Control0..*
              Is Modifierfalse
              Summaryfalse
              Alternate NamesAdjudication Request, Preauthorization Request, Predetermination Request
              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())
              2. Claim.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. Claim.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
              Control0..1
              TypeMeta
              Is Modifierfalse
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              6. Claim.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()))
              8. Claim.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()))
              10. Claim.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()))
              12. Claim.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
              14. Claim.extension
              Definition

              An Extension

              ShortExtension
              Control0..*
              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 Claim.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

                16. Claim.extension:submissionContext
                Slice NamesubmissionContext
                Definition

                Asserted source context for a submission. This is provenance only: it MUST NOT override the authenticated identity, and MUST NOT be used for authentication or authorisation.

                The SOAP to FHIR Broker populates this from the legacy HL7 payload (ZSS.1, ZSL.1-ZSL.4, ZSU.1). Direct FHIR clients may omit it, in which case the API derives the values from the authenticated channel context.

                Note: the detailed design places this extension on Bundle. In FHIR R4 Bundle is a Resource, not a DomainResource, and cannot carry extensions, so this guide places it on the focal Claim. See Design Notes.

                ShortAsserted source context - provenance only
                Control0..1
                This element is affected by the following invariants: ele-1
                TypeExtension(Submission Context) (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())
                18. Claim.extension:applicationStatus
                Slice NameapplicationStatus
                Definition

                The HSAAP status and outcome of a Special Authority Application. The same shape is returned whether the status arrives synchronously from $submit or later through Application Enquiry (D22).

                Carried on ClaimResponse. It may also be carried on Claim in Application Enquiry results so that the application-status search parameter on Claim has an element to evaluate (see Design Notes).

                ShortPopulated by the API on Application Enquiry. SHALL NOT be sent on submission.
                Control0..1
                This element is affected by the following invariants: ele-1
                TypeExtension(Application Status) (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-appstatus-1: An outcome is present if, and only if, status is DONE. (extension('outcome').exists() = extension('status').where(value = 'DONE').exists())
                20. Claim.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())
                22. Claim.identifier
                Definition

                A unique identifier assigned to this claim.

                ShortApplication Number - populated by the API, absent on submission
                NoteThis is a business identifier, not a resource identifier (see discussion)
                Control0..1
                TypeIdentifier
                Is Modifierfalse
                Must Supporttrue
                Summaryfalse
                Requirements

                Allows claims to be distinguished and referenced.

                Alternate NamesClaim Number
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                24. Claim.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
                26. Claim.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 Claim.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 28. Claim.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()))
                  30. Claim.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()))
                  32. Claim.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/application-number"
                  }
                  <system value="https://fhir-ig.digital.health.nz/special-authority/ns/application-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()))
                  34. Claim.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()))
                  36. Claim.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()))
                  38. Claim.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()))
                  40. Claim.status
                  Definition

                  The status of the resource instance.

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

                  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 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()))
                  42. Claim.type
                  Definition

                  The category of claim, e.g. oral, pharmacy, vision, institutional, professional.

                  ShortCategory or discipline
                  Comments

                  The majority of jurisdictions use: oral, pharmacy, vision, professional and institutional, or variants on those terms, as the general styles of claims. The valueset is extensible to accommodate other jurisdictional requirements.

                  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

                  Claim type determine the general sets of business rules applied for information requirements 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()))
                  44. Claim.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()))
                  46. Claim.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)

                  The purpose of the Claim: predetermination, preauthorization, claim.

                  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()))
                  48. Claim.patient
                  Definition

                  The party to whom the professional services and/or products have been supplied or are being considered and for whom actual or forecast 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 history 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()))
                  50. Claim.billablePeriod
                  Definition

                  The period for which charges are being submitted.

                  ShortRelevant time frame for the claim
                  Comments

                  Typically this would be today or in the past for a claim, and today or in the future for preauthorizations and predeterminations. Typically line item dates of service should fall within the billing period if one is specified.

                  Control0..0
                  TypePeriod
                  Is Modifierfalse
                  Summarytrue
                  Requirements

                  A number jurisdictions required the submission of the billing period when submitting claims for example for hospital stays or long-term care.

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

                  The date this resource was created.

                  ShortResource creation date
                  Comments

                  This field is independent of the date of creation of the resource as it may reflect the creation date of a source document prior to digitization. Typically for claims all services must be completed as of this 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()))
                  54. Claim.enterer
                  Definition

                  Individual who created the claim, predetermination or preauthorization.

                  ShortAuthor of the claim
                  Control0..0
                  TypeReference(Practitioner, PractitionerRole)
                  Is Modifierfalse
                  Summaryfalse
                  Requirements

                  Some jurisdictions require the contact information for personnel completing claims.

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

                  The Insurer who is target of the request.

                  ShortTarget
                  Control0..0
                  TypeReference(Organization)
                  Is Modifierfalse
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  58. Claim.provider
                  Definition

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

                  ShortThe Applicant - same Practitioner as QuestionnaireResponse.author
                  Comments

                  The detailed design refers to Claim.requestor, which does not exist in FHIR R4 Claim. Claim.provider ('the provider responsible for the preauthorization') is used instead. The custom 'requestor' search parameter on Claim evaluates Claim.provider so the API contract is preserved.

                  Control1..1
                  TypeReference(SA Practitioner)
                  Is Modifierfalse
                  Must Supporttrue
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  60. Claim.priority
                  Definition

                  The provider-required urgency of processing the request. Typical values include: stat, routine deferred.

                  ShortDesired processing ugency
                  Comments

                  If a claim processor is unable to complete the processing as per the priority then they should generate and error and not process the request.

                  Control1..1
                  BindingFor example codes, see ProcessPriorityCodes
                  (example to http://hl7.org/fhir/ValueSet/process-priority|4.0.1)

                  The timeliness with which processing is required: stat, normal, deferred.

                  TypeCodeableConcept
                  Is Modifierfalse
                  Summarytrue
                  Requirements

                  The provider may need to indicate their processing requirements so that the processor can indicate if they are unable to comply.

                  Pattern Value
                  {
                    "coding" : [
                      {
                        "system" : "http://terminology.hl7.org/CodeSystem/processpriority",
                        "code" : "normal"
                      }
                    ]
                  }
                  <priority>
                    <coding>
                      <system value="http://terminology.hl7.org/CodeSystem/processpriority"/>
                      <code value="normal"/>
                    </coding>
                  </priority>
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  62. Claim.fundsReserve
                  Definition

                  A code to indicate whether and for whom funds are to be reserved for future claims.

                  ShortFor whom to reserve funds
                  Comments

                  This field is only used for preauthorizations.

                  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

                  In the case of a Pre-Determination/Pre-Authorization the provider may request that funds in the amount of the expected Benefit be reserved ('Patient' or 'Provider') to pay for the Benefits determined on the subsequent claim(s). 'None' explicitly indicates no funds reserving is requested.

                  Alternate NamesFund pre-allocation
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  64. Claim.related
                  Definition

                  Other claims which are related to this claim such as prior submissions or claims for related services or for the same event.

                  ShortPrior or corollary claims
                  Comments

                  For example, for the original treatment and follow-up exams.

                  Control0..0
                  TypeBackboneElement
                  Is Modifierfalse
                  Summaryfalse
                  Requirements

                  For workplace or other accidents it is common to relate separate claims arising from the same event.

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

                  Prescription to support the dispensing of pharmacy, device or vision products.

                  ShortPrescription authorizing services and products
                  Control0..0
                  TypeReference(DeviceRequest, MedicationRequest, VisionPrescription)
                  Is Modifierfalse
                  Summaryfalse
                  Requirements

                  Required to authorize the dispensing of controlled substances and devices.

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

                  Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products.

                  ShortOriginal prescription if superseded by fulfiller
                  Comments

                  For example, a physician may prescribe a medication which the pharmacy determines is contraindicated, or for which the patient has an intolerance, and therefore issues a new prescription for an alternate medication which has the same therapeutic intent. The prescription from the pharmacy becomes the 'prescription' and that from the physician becomes the 'original prescription'.

                  Control0..0
                  TypeReference(DeviceRequest, MedicationRequest, VisionPrescription)
                  Is Modifierfalse
                  Summaryfalse
                  Requirements

                  Often required when a fulfiller varies what is fulfilled from that authorized on the original prescription.

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

                  The party to be reimbursed for cost of the products and services according to the terms of the policy.

                  ShortRecipient of benefits payable
                  Comments

                  Often providers agree to receive the benefits payable to reduce the near-term costs to the patient. The insurer may decline to pay the provider and choose to pay the subscriber instead.

                  Control0..0
                  TypeBackboneElement
                  Is Modifierfalse
                  Summaryfalse
                  Requirements

                  The provider needs to specify who they wish to be reimbursed and the claims processor needs express who they will reimburse.

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

                  A reference to a referral resource.

                  ShortTreatment referral
                  Comments

                  The referrer is carried by the referring-practitioner extension on the QuestionnaireResponse.

                  Control0..0
                  TypeReference(ServiceRequest)
                  Is Modifierfalse
                  Summaryfalse
                  Requirements

                  Some insurers require proof of referral to pay for services or to pay specialist rates for services.

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

                  Facility where the services were provided.

                  ShortServicing facility
                  Control0..0
                  TypeReference(Location)
                  Is Modifierfalse
                  Summaryfalse
                  Requirements

                  Insurance adjudication can be dependant on where services were delivered.

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

                  The members of the team who provided the products and services.

                  ShortMembers of the care team
                  Control0..0
                  TypeBackboneElement
                  Is Modifierfalse
                  Summaryfalse
                  Requirements

                  Common to identify the responsible and supporting practitioners.

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

                  Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues.

                  ShortSupporting information
                  Comments

                  Often there are multiple jurisdiction specific valuesets which are required.

                  Control1..*
                  TypeBackboneElement
                  Is Modifierfalse
                  Must Supporttrue
                  Summaryfalse
                  Requirements

                  Typically these information codes are required to support the services rendered or the adjudication of the services rendered.

                  Alternate NamesAttachments Exception Codes Occurrence Codes Value codes
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  SlicingThis element introduces a set of slices on Claim.supportingInfo. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • pattern @ category
                  • Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

                    99. Claim.supportingInfo.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
                    101. Claim.supportingInfo.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())
                    103. Claim.supportingInfo.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())
                    105. Claim.supportingInfo.sequence
                    Definition

                    A number to uniquely identify supporting information entries.

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

                    Necessary to maintain the order of the supporting information items and provide a mechanism to link to claim details.

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

                    The general class of the information supplied: information; exception; accident, employment; onset, etc.

                    ShortClassification of the supplied information
                    Comments

                    This may contain a category for the local bill type codes.

                    Control1..1
                    BindingFor example codes, see ClaimInformationCategoryCodes
                    (example to http://hl7.org/fhir/ValueSet/claim-informationcategory|4.0.1)

                    The valuset used for additional information category codes.

                    TypeCodeableConcept
                    Is Modifierfalse
                    Summaryfalse
                    Requirements

                    Required to group or associate information items with common characteristics. For example: admission information or prior treatments.

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

                    System and code pertaining to the specific information regarding special conditions relating to the setting, treatment or patient for which care is sought.

                    ShortType of information
                    Control0..1
                    BindingFor example codes, see ExceptionCodes
                    (example to http://hl7.org/fhir/ValueSet/claim-exception|4.0.1)

                    The valuset used for additional information codes.

                    TypeCodeableConcept
                    Is Modifierfalse
                    Summaryfalse
                    Requirements

                    Required to identify the kind of additional information.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    111. Claim.supportingInfo.timing[x]
                    Definition

                    The date when or period to which this information refers.

                    ShortWhen it occurred
                    Control0..1
                    TypeChoice of: date, Period
                    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                    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()))
                    113. Claim.supportingInfo.value[x]
                    Definition

                    Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.

                    ShortData to be provided
                    Comments

                    Could be used to provide references to other resources, document. For example could contain a PDF in an Attachment of the Police Report for an Accident.

                    Control0..1
                    TypeChoice of: boolean, string, Quantity, Attachment, Reference(Resource)
                    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summaryfalse
                    Requirements

                    To convey the data content to be provided when the information is more than a simple code or period.

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

                    Provides the reason in the situation where a reason code is required in addition to the content.

                    ShortExplanation for the information
                    Comments

                    For example: the reason for the additional stay, or why a tooth is missing.

                    Control0..1
                    BindingFor example codes, see MissingToothReasonCodes
                    (example to http://hl7.org/fhir/ValueSet/missing-tooth-reason|4.0.1)

                    Reason codes for the missing teeth.

                    TypeCodeableConcept
                    Is Modifierfalse
                    Summaryfalse
                    Requirements

                    Needed when the supporting information has both a date and amount/value and requires explanation.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    117. Claim.supportingInfo:questionnaireResponse
                    Slice NamequestionnaireResponse
                    Definition

                    Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues.

                    ShortSupporting information
                    Comments

                    Often there are multiple jurisdiction specific valuesets which are required.

                    Control1..1
                    TypeBackboneElement
                    Is Modifierfalse
                    Must Supporttrue
                    Summaryfalse
                    Requirements

                    Typically these information codes are required to support the services rendered or the adjudication of the services rendered.

                    Alternate NamesAttachments Exception Codes Occurrence Codes Value codes
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    119. Claim.supportingInfo:questionnaireResponse.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
                    121. Claim.supportingInfo:questionnaireResponse.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())
                    123. Claim.supportingInfo:questionnaireResponse.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())
                    125. Claim.supportingInfo:questionnaireResponse.sequence
                    Definition

                    A number to uniquely identify supporting information entries.

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

                    Necessary to maintain the order of the supporting information items and provide a mechanism to link to claim details.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    127. Claim.supportingInfo:questionnaireResponse.category
                    Definition

                    The general class of the information supplied: information; exception; accident, employment; onset, etc.

                    ShortClassification of the supplied information
                    Comments

                    This may contain a category for the local bill type codes.

                    Control1..1
                    BindingFor example codes, see ClaimInformationCategoryCodes
                    (example to http://hl7.org/fhir/ValueSet/claim-informationcategory|4.0.1)

                    The valuset used for additional information category codes.

                    TypeCodeableConcept
                    Is Modifierfalse
                    Summaryfalse
                    Requirements

                    Required to group or associate information items with common characteristics. For example: admission information or prior treatments.

                    Pattern Value
                    {
                      "coding" : [
                        {
                          "system" : "https://fhir-ig.digital.health.nz/special-authority/CodeSystem/sa-supporting-info-category",
                          "code" : "questionnaire-response"
                        }
                      ]
                    }
                    <category>
                      <coding>
                        <system value="https://fhir-ig.digital.health.nz/special-authority/CodeSystem/sa-supporting-info-category"/>
                        <code value="questionnaire-response"/>
                      </coding>
                    </category>
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    129. Claim.supportingInfo:questionnaireResponse.code
                    Definition

                    System and code pertaining to the specific information regarding special conditions relating to the setting, treatment or patient for which care is sought.

                    ShortType of information
                    Control0..1
                    BindingFor example codes, see ExceptionCodes
                    (example to http://hl7.org/fhir/ValueSet/claim-exception|4.0.1)

                    The valuset used for additional information codes.

                    TypeCodeableConcept
                    Is Modifierfalse
                    Summaryfalse
                    Requirements

                    Required to identify the kind of additional information.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    131. Claim.supportingInfo:questionnaireResponse.timing[x]
                    Definition

                    The date when or period to which this information refers.

                    ShortWhen it occurred
                    Control0..1
                    TypeChoice of: date, Period
                    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                    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()))
                    133. Claim.supportingInfo:questionnaireResponse.value[x]
                    Definition

                    Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.

                    ShortData to be provided
                    Comments

                    Could be used to provide references to other resources, document. For example could contain a PDF in an Attachment of the Police Report for an Accident.

                    Control1..1
                    TypeReference(SA QuestionnaireResponse)
                    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                    Is Modifierfalse
                    Must Supporttrue
                    Summaryfalse
                    Requirements

                    To convey the data content to be provided when the information is more than a simple code or period.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    135. Claim.supportingInfo:questionnaireResponse.reason
                    Definition

                    Provides the reason in the situation where a reason code is required in addition to the content.

                    ShortExplanation for the information
                    Comments

                    For example: the reason for the additional stay, or why a tooth is missing.

                    Control0..1
                    BindingFor example codes, see MissingToothReasonCodes
                    (example to http://hl7.org/fhir/ValueSet/missing-tooth-reason|4.0.1)

                    Reason codes for the missing teeth.

                    TypeCodeableConcept
                    Is Modifierfalse
                    Summaryfalse
                    Requirements

                    Needed when the supporting information has both a date and amount/value and requires explanation.

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

                    Information about diagnoses relevant to the claim items.

                    ShortPertinent diagnosis information
                    Control0..0
                    TypeBackboneElement
                    Is Modifierfalse
                    Summaryfalse
                    Requirements

                    Required for the adjudication by provided context for the services and product listed.

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

                    Procedures performed on the patient relevant to the billing items with the claim.

                    ShortClinical procedures performed
                    Control0..0
                    TypeBackboneElement
                    Is Modifierfalse
                    Summaryfalse
                    Requirements

                    The specific clinical invention are sometimes required to be provided to justify billing a greater than customary amount for a service.

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

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

                    ShortMandatory in FHIR R4 - logical reference to the Pharmaceutical Schedule only
                    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 'Coverage.subrogation=false', should provide a reference to the ClaimResponse containing the adjudication results of the prior claim.

                    Control1..1
                    TypeBackboneElement
                    Is Modifierfalse
                    Summarytrue
                    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()))
                    159. Claim.insurance.id
                    Definition

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

                    ShortUnique id for inter-element referencing
                    Control0..1
                    Typestring
                    Is Modifierfalse
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Summaryfalse
                    161. Claim.insurance.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())
                    163. Claim.insurance.modifierExtension
                    Definition

                    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element 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())
                    165. Claim.insurance.sequence
                    Definition

                    A number to uniquely identify insurance entries and provide a sequence of coverages to convey coordination of benefit order.

                    ShortInsurance instance identifier
                    Control1..1
                    TypepositiveInt
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    Requirements

                    To maintain order of the coverages.

                    Pattern Value
                    {
                      "sequence" : 1
                    }
                    <sequence value="1"/>
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    167. Claim.insurance.focal
                    Definition

                    A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true.

                    ShortCoverage to be used for adjudication
                    Comments

                    A patient may (will) have multiple insurance policies which provide reimbursement for healthcare services and products. For example a person may also be covered by their spouse's policy and both appear in the list (and may be from the same insurer). This flag will be set to true for only one of the listed policies and that policy will be used for adjudicating this claim. Other claims would be created to request adjudication against the other listed policies.

                    Control1..1
                    Typeboolean
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    Requirements

                    To identify which coverage in the list is being used to adjudicate this claim.

                    Fixed Value
                    {
                      "focal" : true
                    }
                    <focal value="true"/>
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    169. Claim.insurance.identifier
                    Definition

                    The business identifier to be used when the claim is sent for adjudication against this insurance policy.

                    ShortPre-assigned Claim number
                    Comments

                    Only required in jurisdictions where insurers, rather than the provider, are required to send claims to insurers that appear after them in the list. This element is not required when 'subrogation=true'.

                    NoteThis is a business identifier, not a resource identifier (see discussion)
                    Control0..0
                    TypeIdentifier
                    Is Modifierfalse
                    Summaryfalse
                    Requirements

                    This will be the claim number should it be necessary to create this claim in the future. This is provided so that payors may forward claims to other payors in the Coordination of Benefit for adjudication rather than the provider being required to initiate each adjudication.

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

                    Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system.

                    ShortInsurance information
                    Control1..1
                    TypeReference(Coverage)
                    Is Modifierfalse
                    Summarytrue
                    Requirements

                    Required to allow the adjudicator to locate the correct policy and history within their information system.

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

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

                    ShortUnique id for inter-element referencing
                    Control0..1
                    Typestring
                    Is Modifierfalse
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Summaryfalse
                    175. Claim.insurance.coverage.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 Claim.insurance.coverage.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ url
                    • 177. Claim.insurance.coverage.reference
                      Definition

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

                      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()))
                      179. Claim.insurance.coverage.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()))
                      181. Claim.insurance.coverage.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()))
                      183. Claim.insurance.coverage.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
                      Pattern Value
                      {
                        "display" : "Pharmaceutical Schedule"
                      }
                      <display value="Pharmaceutical Schedule"/>
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      185. Claim.insurance.businessArrangement
                      Definition

                      A business agreement number established between the provider and the insurer for special business processing purposes.

                      ShortAdditional provider contract number
                      Control0..0
                      Typestring
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summaryfalse
                      Requirements

                      Providers may have multiple business arrangements with a given insurer and must supply the specific contract number for adjudication.

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

                      Reference numbers previously provided by the insurer to the provider to be quoted on subsequent claims containing services or products related to the prior authorization.

                      ShortPrior authorization reference number
                      Comments

                      This value is an alphanumeric string that may be provided over the phone, via text, via paper, or within a ClaimResponse resource and is not a FHIR Identifier.

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

                      Providers must quote previously issued authorization reference numbers in order to obtain adjudication as previously advised on the Preauthorization.

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

                      The result of the adjudication of the line items for the Coverage specified in this insurance.

                      ShortAdjudication results
                      Comments

                      Must not be specified when 'focal=true' for this insurance.

                      Control0..0
                      TypeReference(ClaimResponse)
                      Is Modifierfalse
                      Summaryfalse
                      Requirements

                      An insurer need the adjudication results from prior insurers to determine the outstanding balance remaining by item for the items in the curent claim.

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

                      Details of an accident which resulted in injuries which required the products and services listed in the claim.

                      ShortDetails of the event
                      Control0..0
                      TypeBackboneElement
                      Is Modifierfalse
                      Summaryfalse
                      Requirements

                      When healthcare products and services are accident related, benefits may be payable under accident provisions of policies, such as automotive, etc before they are payable under normal health insurance.

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

                      A claim line. Either a simple product or service or a 'group' of details which can each be a simple items or groups of sub-details.

                      ShortRequested pharmaceuticals - NPPA and panel approval Applications only
                      Control0..*
                      TypeBackboneElement
                      Is Modifierfalse
                      Must Supporttrue
                      Summaryfalse
                      Requirements

                      The items to be processed for adjudication.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      sa-claim-1: A requested pharmaceutical SHALL be identified by a CTPP ID or a Pharmacode. (productOrService.coding.where(system = 'http://nzmt.org.nz' or system = 'https://fhir-ig.digital.health.nz/special-authority/ns/pharmacode').exists())
                      201. Claim.item.id
                      Definition

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

                      ShortUnique id for inter-element referencing
                      Control0..1
                      Typestring
                      Is Modifierfalse
                      XML FormatIn the XML format, this property is represented as an attribute.
                      Summaryfalse
                      203. Claim.item.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())
                      205. Claim.item.modifierExtension
                      Definition

                      May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element 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())
                      207. Claim.item.sequence
                      Definition

                      A number to uniquely identify item entries.

                      ShortItem instance identifier
                      Control1..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 to items from within the claim and within the adjudication details of the ClaimResponse.

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

                      CareTeam members related to this service or product.

                      ShortApplicable careTeam members
                      Control0..0
                      TypepositiveInt
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summaryfalse
                      Requirements

                      Need to identify the individuals and their roles in the provision of the product or service.

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

                      Diagnosis applicable for this service or product.

                      ShortApplicable diagnoses
                      Control0..0
                      TypepositiveInt
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summaryfalse
                      Requirements

                      Need to related the product or service to the associated diagnoses.

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

                      Procedures applicable for this service or product.

                      ShortApplicable procedures
                      Control0..0
                      TypepositiveInt
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summaryfalse
                      Requirements

                      Need to provide any listed specific procedures to support the product or service being claimed.

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

                      Exceptions, special conditions and supporting information applicable for this service or product.

                      ShortApplicable exception and supporting information
                      Control0..0
                      TypepositiveInt
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summaryfalse
                      Requirements

                      Need to reference the supporting information items that relate directly to this product or service.

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

                      The type of revenue or cost center providing the product and/or service.

                      ShortRevenue or cost center code
                      Control0..0
                      BindingFor example codes, see ExampleRevenueCenterCodes
                      (example to http://hl7.org/fhir/ValueSet/ex-revenue-center|4.0.1)

                      Codes for the revenue or cost centers supplying the service and/or products.

                      TypeCodeableConcept
                      Is Modifierfalse
                      Summaryfalse
                      Requirements

                      Needed in the processing of institutional claims.

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

                      Code to identify the general type of benefits under which products and services are provided.

                      ShortBenefit classification
                      Comments

                      Examples include Medical Care, Periodontics, Renal Dialysis, Vision Coverage.

                      Control0..0
                      BindingFor example codes, see BenefitCategoryCodes
                      (example to http://hl7.org/fhir/ValueSet/ex-benefitcategory|4.0.1)

                      Benefit categories such as: oral-basic, major, glasses.

                      TypeCodeableConcept
                      Is Modifierfalse
                      Summaryfalse
                      Requirements

                      Needed in the processing of institutional claims as this allows the insurer to determine whether a facial X-Ray is for dental, orthopedic, or facial surgery purposes.

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

                      When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.

                      ShortBilling, service, product, or drug code
                      Comments

                      If this is an actual service or product line, i.e. not a Group, then use code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS, USCLS, ICD10, NCPDP, DIN, RxNorm, ACHI, CCI). If a grouping item then use a group code to indicate the type of thing being grouped e.g. 'glasses' or 'compound'.

                      Control1..1
                      BindingFor example codes, see USCLSCodes
                      (example to http://hl7.org/fhir/ValueSet/service-uscls|4.0.1)

                      Allowable service and product codes.

                      TypeCodeableConcept
                      Is Modifierfalse
                      Must Supporttrue
                      Summaryfalse
                      Requirements

                      Necessary to state what was provided or done.

                      Alternate NamesDrug Code, Bill Code, Service Code
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      223. Claim.item.productOrService.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
                      225. Claim.item.productOrService.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 Claim.item.productOrService.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ url
                      • 227. Claim.item.productOrService.coding
                        Definition

                        A reference to a code defined by a terminology system.

                        ShortCode defined by a terminology system
                        Comments

                        Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                        Control1..*
                        TypeCoding
                        Is Modifierfalse
                        Must Supporttrue
                        Summarytrue
                        Requirements

                        Allows for alternative encodings within a code system, and translations to other code systems.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        SlicingThis element introduces a set of slices on Claim.item.productOrService.coding. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • value @ system
                        • Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

                          229. Claim.item.productOrService.coding:ctpp
                          Slice Namectpp
                          Definition

                          A reference to a code defined by a terminology system.

                          ShortNZMT CTPP ID (preferred)
                          Comments

                          Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                          Control0..1
                          TypeCoding
                          Is Modifierfalse
                          Must Supporttrue
                          Summarytrue
                          Requirements

                          Allows for alternative encodings within a code system, and translations to other code systems.

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          231. Claim.item.productOrService.coding:ctpp.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
                          233. Claim.item.productOrService.coding:ctpp.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 Claim.item.productOrService.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                          • value @ url
                          • 235. Claim.item.productOrService.coding:ctpp.system
                            Definition

                            The identification of the code system that defines the meaning of the symbol in the code.

                            ShortIdentity of the terminology system
                            Comments

                            The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                            Control1..1
                            Typeuri
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            Requirements

                            Need to be unambiguous about the source of the definition of the symbol.

                            Fixed Value
                            {
                              "system" : "http://nzmt.org.nz"
                            }
                            <system value="http://nzmt.org.nz"/>
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            237. Claim.item.productOrService.coding:ctpp.version
                            Definition

                            The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                            ShortVersion of the system - if relevant
                            Comments

                            Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                            NoteThis is a business version Id, not a resource version Id (see discussion)
                            Control0..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()))
                            239. Claim.item.productOrService.coding:ctpp.code
                            Definition

                            A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                            ShortSymbol in syntax defined by the system
                            Control1..1
                            Typecode
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            Requirements

                            Need to refer to a particular code in the system.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            241. Claim.item.productOrService.coding:ctpp.display
                            Definition

                            A representation of the meaning of the code in the system, following the rules of the system.

                            ShortRepresentation defined by the system
                            Control0..1
                            Typestring
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Must Supporttrue
                            Summarytrue
                            Requirements

                            Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            243. Claim.item.productOrService.coding:ctpp.userSelected
                            Definition

                            Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                            ShortIf this coding was chosen directly by the user
                            Comments

                            Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                            Control0..1
                            Typeboolean
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            Requirements

                            This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            245. Claim.item.productOrService.coding:pharmacode
                            Slice Namepharmacode
                            Definition

                            A reference to a code defined by a terminology system.

                            ShortPharmac Pharmacode
                            Comments

                            Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                            Control0..1
                            TypeCoding
                            Is Modifierfalse
                            Must Supporttrue
                            Summarytrue
                            Requirements

                            Allows for alternative encodings within a code system, and translations to other code systems.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            247. Claim.item.productOrService.coding:pharmacode.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
                            249. Claim.item.productOrService.coding:pharmacode.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 Claim.item.productOrService.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                            • value @ url
                            • 251. Claim.item.productOrService.coding:pharmacode.system
                              Definition

                              The identification of the code system that defines the meaning of the symbol in the code.

                              ShortIdentity of the terminology system
                              Comments

                              The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                              Control1..1
                              Typeuri
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summarytrue
                              Requirements

                              Need to be unambiguous about the source of the definition of the symbol.

                              Fixed Value
                              {
                                "system" : "https://fhir-ig.digital.health.nz/special-authority/ns/pharmacode"
                              }
                              <system value="https://fhir-ig.digital.health.nz/special-authority/ns/pharmacode"/>
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              253. Claim.item.productOrService.coding:pharmacode.version
                              Definition

                              The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                              ShortVersion of the system - if relevant
                              Comments

                              Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                              NoteThis is a business version Id, not a resource version Id (see discussion)
                              Control0..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()))
                              255. Claim.item.productOrService.coding:pharmacode.code
                              Definition

                              A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                              ShortSymbol in syntax defined by the system
                              Control1..1
                              Typecode
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summarytrue
                              Requirements

                              Need to refer to a particular code in the system.

                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              257. Claim.item.productOrService.coding:pharmacode.display
                              Definition

                              A representation of the meaning of the code in the system, following the rules of the system.

                              ShortRepresentation defined by the system
                              Control0..1
                              Typestring
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Must Supporttrue
                              Summarytrue
                              Requirements

                              Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              259. Claim.item.productOrService.coding:pharmacode.userSelected
                              Definition

                              Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                              ShortIf this coding was chosen directly by the user
                              Comments

                              Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                              Control0..1
                              Typeboolean
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summarytrue
                              Requirements

                              This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              261. Claim.item.productOrService.text
                              Definition

                              A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                              ShortPlain text representation of the concept
                              Comments

                              Very often the text is the same as a displayName of one of the codings.

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

                              The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

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

                              Item typification or modifiers codes to convey additional context for the product or service.

                              ShortProduct or service billing modifiers
                              Comments

                              For example in Oral whether the treatment is cosmetic or associated with TMJ, or for Medical whether the treatment was outside the clinic or outside of office hours.

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

                              Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.

                              TypeCodeableConcept
                              Is Modifierfalse
                              Summaryfalse
                              Requirements

                              To support inclusion of the item for adjudication or to charge an elevated fee.

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

                              Identifies the program under which this may be recovered.

                              ShortProgram the product or service is provided under
                              Comments

                              For example: Neonatal program, child dental program or drug users recovery program.

                              Control0..0
                              BindingFor example codes, see ExampleProgramReasonCodes
                              (example to http://hl7.org/fhir/ValueSet/ex-program-code|4.0.1)

                              Program specific reason codes.

                              TypeCodeableConcept
                              Is Modifierfalse
                              Summaryfalse
                              Requirements

                              Commonly used in in the identification of publicly provided program focused on population segments or disease classifications.

                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              267. Claim.item.serviced[x]
                              Definition

                              The date or dates when the service or product was supplied, performed or completed.

                              ShortDate or dates of service or product delivery
                              Control0..0
                              TypeChoice of: date, Period
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summaryfalse
                              Requirements

                              Needed to determine whether the service or product was provided during the term of the insurance coverage.

                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              269. Claim.item.location[x]
                              Definition

                              Where the product or service was provided.

                              ShortPlace of service or where product was supplied
                              Control0..0
                              BindingFor example codes, see ExampleServicePlaceCodes
                              (example to http://hl7.org/fhir/ValueSet/service-place|4.0.1)

                              Place of service: pharmacy, school, prison, etc.

                              TypeChoice of: CodeableConcept, Address, Reference(Location)
                              Is Modifierfalse
                              Summaryfalse
                              Requirements

                              The location can alter whether the item was acceptable for insurance purposes or impact the determination of the benefit amount.

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

                              The number of repetitions of a service or product.

                              ShortCount of products or services
                              Control0..1
                              TypeQuantity(SimpleQuantity)
                              Is Modifierfalse
                              Summaryfalse
                              Requirements

                              Required when the product or service code does not convey the quantity provided.

                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              sqty-1: The comparator is not used on a SimpleQuantity (comparator.empty())
                              273. Claim.item.unitPrice
                              Definition

                              If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.

                              ShortFee, charge or cost per item
                              Control0..0
                              TypeMoney
                              Is Modifierfalse
                              Summaryfalse
                              Requirements

                              The amount charged to the patient by the provider for a single unit.

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

                              A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

                              ShortPrice scaling factor
                              Comments

                              To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10).

                              Control0..0
                              Typedecimal
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summaryfalse
                              Requirements

                              When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication.

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

                              The quantity times the unit price for an additional service or product or charge.

                              ShortTotal item cost
                              Comments

                              For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.

                              Control0..0
                              TypeMoney
                              Is Modifierfalse
                              Summaryfalse
                              Requirements

                              Provides the total amount claimed for the group (if a grouper) or the line item.

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

                              Unique Device Identifiers associated with this line item.

                              ShortUnique device identifier
                              Control0..0
                              TypeReference(Device)
                              Is Modifierfalse
                              Summaryfalse
                              Requirements

                              The UDI code allows the insurer to obtain device level information on the product supplied.

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

                              Physical service site on the patient (limb, tooth, etc.).

                              ShortAnatomical location
                              Comments

                              For example: Providing a tooth code, allows an insurer to identify a provider performing a filling on a tooth that was previously removed.

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

                              The code for the teeth, quadrant, sextant and arch.

                              TypeCodeableConcept
                              Is Modifierfalse
                              Summaryfalse
                              Requirements

                              Allows insurer to validate specific procedures.

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

                              A region or surface of the bodySite, e.g. limb region or tooth surface(s).

                              ShortAnatomical sub-location
                              Control0..0
                              BindingFor example codes, see SurfaceCodes
                              (example to http://hl7.org/fhir/ValueSet/surface|4.0.1)

                              The code for the tooth surface and surface combinations.

                              TypeCodeableConcept
                              Is Modifierfalse
                              Summaryfalse
                              Requirements

                              Allows insurer to validate specific procedures.

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

                              The Encounters during which this Claim was created or to which the creation of this record is tightly associated.

                              ShortEncounters related to this billed item
                              Comments

                              This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter.

                              Control0..0
                              TypeReference(Encounter)
                              Is Modifierfalse
                              Summaryfalse
                              Requirements

                              Used in some jurisdictions to link clinical events to claim items.

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

                              A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items.

                              ShortProduct or service provided
                              Control0..0
                              TypeBackboneElement
                              Is Modifierfalse
                              Summaryfalse
                              Requirements

                              The items to be processed for adjudication.

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

                              The total value of the all the items in the claim.

                              ShortTotal claim cost
                              Control0..0
                              TypeMoney
                              Is Modifierfalse
                              Summaryfalse
                              Requirements

                              Used for control total purposes.

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