Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.5 - release New Zealand flag

Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.5) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: NzPharmacyClaim - Detailed Descriptions

Draft as of 2026-06-04

Definitions for the NzPharmacyClaim resource profile.

Guidance on how to interpret the contents of this table can be foundhere

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.meta
Definition

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

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

Captures the source of the record. This must contain the HPIFacilityID e.g. https://standards.digital.health.nz/ns/hpi-facility-id/FZZ111-A


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

ShortHPI Facility ID from where the record is sourcedIdentifies where the resource comes from
Comments

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

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

Control10..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
hpi-location-url-format: Reference must be an HPI facility URL with format https://standards.digital.health.nz/ns/hpi-facility-id/FZZ111-A (matches('^https://standards.digital.health.nz/ns/hpi-facility-id/F[A-Za-z0-9]{2}[0-9]{3}-[A-Za-z0-9]$'))
6. Claim.meta.profile
Definition

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


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

ShortProfiles this resource claims to conform to
Comments

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

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

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

ShortTags applied to this resource
Comments

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

Control10..*
BindingFor example codes, see CommonTagshttp://hl7.org/fhir/ValueSet/common-tags
(example to http://hl7.org/fhir/ValueSet/common-tags)

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

TypeCoding
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Claim.meta.tag. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ system
  • 10. Claim.meta.tag:correlationId
    Slice NamecorrelationId
    Definition

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

    ShortTags applied to this resource
    Comments

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

    Control10..1*
    BindingFor example codes, see CommonTagshttp://hl7.org/fhir/ValueSet/common-tags
    (example to http://hl7.org/fhir/ValueSet/common-tags)

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

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

    The system URI used by the hub to identify its correlation ID.


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

    ShortHub correlation ID systemIdentity 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.

    Pattern Valuehttps://hub.services.digital.health.nz/ns/correlation-id
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    14. Claim.meta.tag:correlationId.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()))
    16. 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()))
    18. 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..0*
    TypeResource
    Is Modifierfalse
    Summaryfalse
    Alternate Namesinline resources, anonymous resources, contained resources
    20. 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.

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

      Indicates the cohort for which the patient belongs, such as CRC, ARRC, LTC, CDOS, PRISON, etc.

      ShortPatient Cohort
      Control0..1
      This element is affected by the following invariants: ele-1
      TypeExtension(Patient Cohort) (Extension Type: CodeableConcept)
      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())
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      24. Claim.extension:claimantNumber
      Slice NameclaimantNumber
      Definition

      The claimant number for the patient.

      ShortClaimant Number
      Control1..1
      This element is affected by the following invariants: ele-1
      TypeExtension(Claimant Number) (Extension Type: string)
      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())
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      26. Claim.extension:originatingClaimantNumber
      Slice NameoriginatingClaimantNumber
      Definition

      The claimant number for the the previous owner.

      ShortOriginating Claimant Number
      Control0..1
      This element is affected by the following invariants: ele-1
      TypeExtension(Originating Claimant Number) (Extension Type: string)
      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())
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      28. 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())
      30. Claim.identifier
      Definition

      A unique identifier assigned to this claim.

      ShortBusiness Identifier for claim
      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control10..*
      TypeIdentifier
      Is Modifierfalse
      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()))
      32. 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()))
      34. 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.

      ExampleGeneral: http://www.acme.com/identifiers/patient
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      36. 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()))
      38. 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'.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      40. 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 NZ Claim Typeshttp://hl7.org/fhir/ValueSet/claim-type
      (extensible to https://fhir-ig.digital.health.nz/shared-care/ValueSet/nz-claim-types)
      TypeCodeableConcept
      Is Modifierfalse
      Summarytrue
      Requirements

      Claim type determine the general sets of business rules applied for information requirements and adjudication.

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

      Control10..1
      BindingUnless not suitable, these codes SHALL be taken from For example codes, see NZ Claim Subtypeshttp://hl7.org/fhir/ValueSet/claim-subtype
      (extensible to https://fhir-ig.digital.health.nz/shared-care/ValueSet/nz-claim-subtypes)
      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()))
      44. 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.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      46. 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(NZ Patient, Patient)
      Is Modifierfalse
      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()))
      48. Claim.patient.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.

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

      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
      Pattern ValuePatient
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      50. Claim.patient.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)
      Control10..1
      TypeIdentifier
      Is Modifierfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      52. Claim.patient.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()))
      54. Claim.patient.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 Valuehttps://standards.digital.health.nz/ns/nhi-id
      ExampleGeneral: http://www.acme.com/identifiers/patient
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      56. Claim.patient.identifier.value
      Definition

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

      ShortMust be an absolute URL reference to the patient on the NHI system. See constraints for details.The 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()))
      nhi-value-format: Reference must be an NHI Patient URL with format ZZZ1111 or ZZZ11AA (matches('^[A-Z]{3}([0-9]{4}|[0-9]{2}[A-Z]{2})$'))
      58. Claim.patient.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.

      Control0..01
      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()))
      60. 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.

      Control10..1
      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()))
      62. Claim.billablePeriod.start
      Definition

      The start of the period. The boundary is inclusive.

      ShortStarting time with inclusive boundary
      Comments

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

      Control10..1
      This element is affected by the following invariants: per-1
      TypedateTime
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      date-only: DateTime must be date-only in yyyy-mm-dd format. Time and timezone values are not accepted. (toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}$'))
      64. Claim.billablePeriod.end
      Definition

      The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

      ShortEnd time with inclusive boundary, if not ongoing
      Comments

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

      Control10..1
      This element is affected by the following invariants: per-1
      TypedateTime
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Meaning if MissingIf the end of the period is missing, it means that the period is ongoing
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      date-only: DateTime must be date-only in yyyy-mm-dd format. Time and timezone values are not accepted. (toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}$'))
      66. 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
      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()))
      full-datetime-with-timezone: DateTime must be ISO 8601 format with time and timezone (e.g., 2026-01-01T00:00:00+13:00 or 2026-01-01T00:00:00Z). Date-only values are not accepted. (toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(\\.[0-9]+)?(Z|[+-][0-9]{2}:[0-9]{2})$'))
      68. 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()))
      70. Claim.provider
      Definition

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

      ShortParty responsible for the claim
      Comments

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

      Control1..1
      TypeReference(Organization, Practitioner, PractitionerRole)
      Is Modifierfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      72. Claim.provider.identifier
      Definition

      A local identifier MUST be added to this section to correlate the organization, facility or nzbn.


      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.

      ShortA local identifier MUST be added to this section.Logical 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)
      Control10..1
      TypeIdentifier
      Is Modifierfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      hpiOrganizationIdPattern: HPI Organisation ID must conform to format (GXXnnn-C). (system = 'https://standards.digital.health.nz/ns/hpi-organisation-id' implies value.matches('^G[a-zA-Z0-9]{2}[0-9]{3}-[a-zA-Z0-9]$'))
      hpiFacilityIdPattern: HPI Facility ID must conform to format (FXXnnn-C). (system = 'https://standards.digital.health.nz/ns/hpi-facility-id' implies value.matches('^F[A-Za-z0-9]{2}[0-9]{3}-[A-Za-z0-9]$'))
      nzbnPattern: NZBN must conform to format (13 digits). (system = 'https://standards.digital.health.nz/ns/hpi-nzbn' implies value.matches('^[0-9]{13}$'))
      hpiCpnPattern: HPI CPN must conform to format (NNXXXX where N is numeric and X is alphabetic). (system = 'https://standards.digital.health.nz/ns/hpi-person-id' implies value.matches('^[0-9]{2}[A-Za-z]{4}$'))
      74. Claim.provider.identifier.use
      Definition

      The purpose of this identifier.

      ShortThe local identifier use SHOULD be set to official.usual | 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()))
      76. Claim.provider.identifier.system
      Definition

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

      ShortThe system identifier for the organization, facility or nzbnThe 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.

      ExampleGeneral: http://www.acme.com/identifiers/patient
      HPI Organisation ID: https://standards.digital.health.nz/ns/hpi-organisation-id
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      allowedLocalIdentifierSystems: Identifier system must be HPI facility, HPI Organisation, HPI CPN or NZBN ($this = 'https://standards.digital.health.nz/ns/hpi-organisation-id' or $this = 'https://standards.digital.health.nz/ns/hpi-nzbn' or $this = 'https://standards.digital.health.nz/ns/hpi-facility-id' or $this = 'https://standards.digital.health.nz/ns/hpi-person-id')
      78. Claim.provider.identifier.value
      Definition

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

      ShortThe actual local identifier value, e.g. GZZ999-ZThe 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
      Example HPI Org ID: GZZ999-Z
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      80. 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
      BindingThe codes SHALL be taken from For example codes, see ProcessPriorityCodeshttp://hl7.org/fhir/ValueSet/process-priority
      (required to http://hl7.org/fhir/ValueSet/process-priority)
      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.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      82. 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
      (example to http://hl7.org/fhir/ValueSet/fundsreserve)

      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()))
      84. 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()))
      86. 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()))
      88. 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()))
      92. 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.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()))
      102. 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()))
      107. Claim.insurance
      Definition

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

      ShortPatient insurance information
      Comments

      All insurance coverages for the patient which may be applicable for reimbursement, of the products and services listed in the claim, are typically provided in the claim to allow insurers to confirm the ordering of the insurance coverages relative to local 'coordination of benefit' rules. One coverage (and only one) with 'focal=true' is to be used in the adjudication of this claim. Coverages appearing before the focal Coverage in the list, and where '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()))
      109. 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())
      111. 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.

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

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

      ShortProduct or service provided
      Control10..*
      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()))
      123. Claim.item.extension
      Definition

      An Extension


      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.

      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.

      Control20..*
      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.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 125. Claim.item.extension:patientFlag
        Slice NamepatientFlag
        Definition

        Indicates a flag relevant to the patient for the pharmacy claim.

        ShortPatient Flag
        Control0..1
        This element is affected by the following invariants: ele-1
        TypeExtension(Patient Flag) (Extension Type: boolean)
        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())
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        127. Claim.item.extension:request
        Slice Namerequest
        Definition

        Reference from a pharmacy claim item to the MedicationDispense that supports the claim item.

        ShortItem Request
        Control1..1
        This element is affected by the following invariants: ele-1
        TypeExtension(Item Request) (Extension Type: Reference(MedicationDispense))
        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())
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        129. Claim.item.extension:request.extension
        Definition

        An Extension


        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.

        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..0*
        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.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 131. Claim.item.extension:request.url
          Definition

          Source of the definition for the extension code - a logical name or a URL.

          Shortidentifies the meaning of the extension
          Comments

          The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

          Control1..1
          Typeuri
          Is Modifierfalse
          XML FormatIn the XML format, this property is represented as an attribute.
          Summaryfalse
          Fixed Valuehttps://fhir-ig.digital.health.nz/shared-care/StructureDefinition/item-request
          133. Claim.item.extension:request.value[x]
          Definition

          Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

          ShortValue of extension
          Control10..1
          TypeReference(NZ Medication Dispense), date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
          Is Modifierfalse
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          135. Claim.item.extension:prescriberFlag
          Slice NameprescriberFlag
          Definition

          Indicates a flag relevant to the prescriber for the pharmacy claim.

          ShortPrescriber Flag
          Control0..1
          This element is affected by the following invariants: ele-1
          TypeExtension(Prescriber Flag) (Extension Type: boolean)
          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())
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          137. Claim.item.extension:prescriptionFlag
          Slice NameprescriptionFlag
          Definition

          Indicates a flag relevant to the prescription for the pharmacy claim.

          ShortPrescription Flag
          Control0..1
          This element is affected by the following invariants: ele-1
          TypeExtension(Prescription Flag) (Extension Type: boolean)
          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())
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          139. Claim.item.extension:doseFlag
          Slice NamedoseFlag
          Definition

          Indicates a flag relevant to the dose for the pharmacy claim.

          ShortDose Flag
          Control0..1
          This element is affected by the following invariants: ele-1
          TypeExtension(Dose Flag) (Extension Type: boolean)
          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())
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          141. Claim.item.extension:groupId
          Slice NamegroupId
          Definition

          A group identifier relevant to the pharmacy claim.

          ShortGroup ID
          Control0..1
          This element is affected by the following invariants: ele-1
          TypeExtension(Group ID) (Extension Type: string)
          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())
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          143. Claim.item.extension:transactionCategory
          Slice NametransactionCategory
          Definition

          The pharmacy claim transaction category.

          ShortTransaction Category
          Control1..1
          This element is affected by the following invariants: ele-1
          TypeExtension(Transaction Category) (Extension Type: CodeableConcept)
          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())
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          145. Claim.item.extension:extendedSupplyFlag
          Slice NameextendedSupplyFlag
          Definition

          Indicates whether the pharmacy claim item relates to extended supply.

          ShortExtended Supply Flag
          Control0..1
          This element is affected by the following invariants: ele-1
          TypeExtension(Extended Supply Flag) (Extension Type: boolean)
          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())
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          147. 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())
          149. 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()))
          151. 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
          (example to http://hl7.org/fhir/ValueSet/ex-revenue-center)

          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()))
          153. 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
          (example to http://hl7.org/fhir/ValueSet/ex-benefitcategory)

          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()))
          155. 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
          (example to http://hl7.org/fhir/ValueSet/service-uscls)

          Allowable service and product codes.

          TypeCodeableConcept
          Is Modifierfalse
          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()))
          157. 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
          (example to http://hl7.org/fhir/ValueSet/claim-modifiers)

          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()))
          159. 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
          (example to http://hl7.org/fhir/ValueSet/ex-program-code)

          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()))
          161. 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
          Control10..1
          TypePeriod, date
          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
          Is Modifierfalse
          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()))
          SlicingThis element introduces a set of slices on Claim.item.serviced[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
          • type @ $this
          • 163. Claim.item.serviced[x]:servicedPeriod
            Slice NameservicedPeriod
            Definition

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

            ShortDate or dates of service or product delivery
            Control10..1
            TypePeriod, date
            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
            Is Modifierfalse
            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()))
            165. Claim.item.serviced[x]:servicedPeriod.start
            Definition

            The start of the period. The boundary is inclusive.

            ShortStarting time with inclusive boundary
            Comments

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

            Control10..1
            This element is affected by the following invariants: per-1
            TypedateTime
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            full-datetime-with-timezone: DateTime must be ISO 8601 format with time and timezone (e.g., 2026-01-01T00:00:00+13:00 or 2026-01-01T00:00:00Z). Date-only values are not accepted. (toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(\\.[0-9]+)?(Z|[+-][0-9]{2}:[0-9]{2})$'))
            167. Claim.item.serviced[x]:servicedPeriod.end
            Definition

            The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

            ShortEnd time with inclusive boundary, if not ongoing
            Comments

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

            Control10..1
            This element is affected by the following invariants: per-1
            TypedateTime
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Meaning if MissingIf the end of the period is missing, it means that the period is ongoing
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            full-datetime-with-timezone: DateTime must be ISO 8601 format with time and timezone (e.g., 2026-01-01T00:00:00+13:00 or 2026-01-01T00:00:00Z). Date-only values are not accepted. (toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(\\.[0-9]+)?(Z|[+-][0-9]{2}:[0-9]{2})$'))
            169. 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()))
            171. 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
            (example to http://hl7.org/fhir/ValueSet/tooth)

            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()))
            173. 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
            (example to http://hl7.org/fhir/ValueSet/surface)

            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()))
            175. 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
            Control10..*
            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()))
            177. Claim.item.detail.extension
            Definition

            An Extension


            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.

            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.item.detail.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 179. Claim.item.detail.extension:balanceOwing
              Slice NamebalanceOwing
              Definition

              Indicates the balance owing for the pharmacy claim item detail.

              ShortBalance Owing
              Control0..1
              This element is affected by the following invariants: ele-1
              TypeExtension(Balance Owing) (Extension Type: string)
              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())
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              181. Claim.item.detail.extension:wastageQuantity
              Slice NamewastageQuantity
              Definition

              Indicates the wastage quantity for the pharmacy claim item detail.

              ShortWastage Quantity
              Control0..1
              This element is affected by the following invariants: ele-1
              TypeExtension(Wastage Quantity) (Extension Type: Quantity)
              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())
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              183. Claim.item.detail.extension:cbsSubsidy
              Slice NamecbsSubsidy
              Definition

              Indicates the CBS subsidy for the pharmacy claim item detail.

              ShortCBS Subsidy
              Control0..1
              This element is affected by the following invariants: ele-1
              TypeExtension(CBS Subsidy) (Extension Type: Money)
              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())
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              185. Claim.item.detail.extension:cbsPackSize
              Slice NamecbsPackSize
              Definition

              Indicates the CBS pack size for the pharmacy claim item detail.

              ShortCBS Pack Size
              Control0..1
              This element is affected by the following invariants: ele-1
              TypeExtension(CBS Pack Size) (Extension Type: Quantity)
              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())
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              187. Claim.item.detail.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())
              189. Claim.item.detail.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()))
              191. Claim.item.detail.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
              (example to http://hl7.org/fhir/ValueSet/ex-revenue-center)

              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()))
              193. Claim.item.detail.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
              (example to http://hl7.org/fhir/ValueSet/ex-benefitcategory)

              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()))
              195. Claim.item.detail.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
              (example to http://hl7.org/fhir/ValueSet/service-uscls)

              Allowable service and product codes.

              TypeCodeableConcept
              Is Modifierfalse
              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()))
              197. Claim.item.detail.modifier
              Definition

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

              ShortService/Product 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 out of office hours.

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

              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()))
              199. Claim.item.detail.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
              (example to http://hl7.org/fhir/ValueSet/ex-program-code)

              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()))
              201. Claim.item.detail.quantity
              Definition

              The number of repetitions of a service or product.

              ShortCount of products or services
              Control10..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()))
              203. Claim.item.detail.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.

              Control10..1
              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()))
              205. Claim.item.detail.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()))
              207. Claim.total
              Definition

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

              ShortTotal claim cost
              Control10..1
              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()))

              Guidance on how to interpret the contents of this table can be foundhere

              0. Claim
              2. Claim.meta
              Control1..?
              4. Claim.meta.source
              Definition

              Captures the source of the record. This must contain the HPIFacilityID e.g. https://standards.digital.health.nz/ns/hpi-facility-id/FZZ111-A

              ShortHPI Facility ID from where the record is sourced
              Control1..?
              Invariantshpi-location-url-format: Reference must be an HPI facility URL with format https://standards.digital.health.nz/ns/hpi-facility-id/FZZ111-A (matches('^https://standards.digital.health.nz/ns/hpi-facility-id/F[A-Za-z0-9]{2}[0-9]{3}-[A-Za-z0-9]$'))
              6. Claim.meta.profile
              Control1..1
              8. Claim.meta.tag
              Control1..?
              SlicingThis element introduces a set of slices on Claim.meta.tag. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ system
              • 10. Claim.meta.tag:correlationId
                Slice NamecorrelationId
                Control1..1
                12. Claim.meta.tag:correlationId.system
                Definition

                The system URI used by the hub to identify its correlation ID.

                ShortHub correlation ID system
                Control1..?
                Pattern Valuehttps://hub.services.digital.health.nz/ns/correlation-id
                14. Claim.meta.tag:correlationId.code
                Control1..?
                16. Claim.contained
                Control0..0
                18. Claim.extension
                Control1..?
                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
                • 20. Claim.extension:patientCohort
                  Slice NamepatientCohort
                  Control0..1
                  TypeExtension(Patient Cohort) (Extension Type: CodeableConcept)
                  22. Claim.extension:claimantNumber
                  Slice NameclaimantNumber
                  Control1..1
                  TypeExtension(Claimant Number) (Extension Type: string)
                  24. Claim.extension:originatingClaimantNumber
                  Slice NameoriginatingClaimantNumber
                  Control0..1
                  TypeExtension(Originating Claimant Number) (Extension Type: string)
                  26. Claim.identifier
                  NoteThis is a business identifier, not a resource identifier (see discussion)
                  Control1..?
                  28. Claim.identifier.system
                  Control1..?
                  30. Claim.identifier.value
                  Control1..?
                  32. Claim.type
                  BindingUnless not suitable, these codes SHALL be taken from NZ Claim Types
                  (extensible to https://fhir-ig.digital.health.nz/shared-care/ValueSet/nz-claim-types)
                  34. Claim.subType
                  Control1..?
                  BindingUnless not suitable, these codes SHALL be taken from NZ Claim Subtypes
                  (extensible to https://fhir-ig.digital.health.nz/shared-care/ValueSet/nz-claim-subtypes)
                  36. Claim.patient
                  TypeReference(NZ Patient, Patient)
                  38. Claim.patient.type
                  Control1..?
                  Pattern ValuePatient
                  40. Claim.patient.identifier
                  NoteThis is a business identifier, not a resource identifier (see discussion)
                  Control1..?
                  42. Claim.patient.identifier.system
                  Control1..?
                  Fixed Valuehttps://standards.digital.health.nz/ns/nhi-id
                  44. Claim.patient.identifier.value
                  ShortMust be an absolute URL reference to the patient on the NHI system. See constraints for details.
                  Control1..?
                  Invariantsnhi-value-format: Reference must be an NHI Patient URL with format ZZZ1111 or ZZZ11AA (matches('^[A-Z]{3}([0-9]{4}|[0-9]{2}[A-Z]{2})$'))
                  46. Claim.patient.display
                  Control0..0
                  48. Claim.billablePeriod
                  Control1..?
                  50. Claim.billablePeriod.start
                  Control1..?
                  Invariantsdate-only: DateTime must be date-only in yyyy-mm-dd format. Time and timezone values are not accepted. (toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}$'))
                  52. Claim.billablePeriod.end
                  Control1..?
                  Invariantsdate-only: DateTime must be date-only in yyyy-mm-dd format. Time and timezone values are not accepted. (toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}$'))
                  54. Claim.created
                  Invariantsfull-datetime-with-timezone: DateTime must be ISO 8601 format with time and timezone (e.g., 2026-01-01T00:00:00+13:00 or 2026-01-01T00:00:00Z). Date-only values are not accepted. (toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(\\.[0-9]+)?(Z|[+-][0-9]{2}:[0-9]{2})$'))
                  56. Claim.insurer
                  Control0..0
                  58. Claim.provider
                  TypeReference(Organization)
                  60. Claim.provider.identifier
                  Definition

                  A local identifier MUST be added to this section to correlate the organization, facility or nzbn.

                  ShortA local identifier MUST be added to this section.
                  NoteThis is a business identifier, not a resource identifier (see discussion)
                  Control1..?
                  InvariantshpiOrganizationIdPattern: HPI Organisation ID must conform to format (GXXnnn-C). (system = 'https://standards.digital.health.nz/ns/hpi-organisation-id' implies value.matches('^G[a-zA-Z0-9]{2}[0-9]{3}-[a-zA-Z0-9]$'))
                  hpiFacilityIdPattern: HPI Facility ID must conform to format (FXXnnn-C). (system = 'https://standards.digital.health.nz/ns/hpi-facility-id' implies value.matches('^F[A-Za-z0-9]{2}[0-9]{3}-[A-Za-z0-9]$'))
                  nzbnPattern: NZBN must conform to format (13 digits). (system = 'https://standards.digital.health.nz/ns/hpi-nzbn' implies value.matches('^[0-9]{13}$'))
                  hpiCpnPattern: HPI CPN must conform to format (NNXXXX where N is numeric and X is alphabetic). (system = 'https://standards.digital.health.nz/ns/hpi-person-id' implies value.matches('^[0-9]{2}[A-Za-z]{4}$'))
                  62. Claim.provider.identifier.use
                  ShortThe local identifier use SHOULD be set to official.
                  64. Claim.provider.identifier.system
                  ShortThe system identifier for the organization, facility or nzbn
                  Control1..?
                  ExampleHPI Organisation ID: https://standards.digital.health.nz/ns/hpi-organisation-id
                  InvariantsallowedLocalIdentifierSystems: Identifier system must be HPI facility, HPI Organisation, HPI CPN or NZBN ($this = 'https://standards.digital.health.nz/ns/hpi-organisation-id' or $this = 'https://standards.digital.health.nz/ns/hpi-nzbn' or $this = 'https://standards.digital.health.nz/ns/hpi-facility-id' or $this = 'https://standards.digital.health.nz/ns/hpi-person-id')
                  66. Claim.provider.identifier.value
                  ShortThe actual local identifier value, e.g. GZZ999-Z
                  Control1..?
                  ExampleExample HPI Org ID: GZZ999-Z
                  68. Claim.priority
                  BindingThe codes SHALL be taken from ProcessPriorityCodes
                  (required to http://hl7.org/fhir/ValueSet/process-priority)
                  70. Claim.fundsReserve
                  Control0..0
                  72. Claim.prescription
                  Control0..0
                  74. Claim.originalPrescription
                  Control0..0
                  76. Claim.payee
                  Control0..0
                  78. Claim.careTeam
                  Control0..0
                  80. Claim.diagnosis
                  Control0..0
                  82. Claim.procedure
                  Control0..0
                  84. Claim.insurance
                  Control0..1
                  86. Claim.accident
                  Control0..0
                  88. Claim.item
                  Control1..?
                  90. Claim.item.extension
                  Control2..?
                  SlicingThis element introduces a set of slices on Claim.item.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 92. Claim.item.extension:patientFlag
                    Slice NamepatientFlag
                    Control0..1
                    TypeExtension(Patient Flag) (Extension Type: boolean)
                    94. Claim.item.extension:request
                    Slice Namerequest
                    Control1..1
                    TypeExtension(Item Request) (Extension Type: Reference(MedicationDispense))
                    96. Claim.item.extension:request.value[x]
                    TypeReference(NZ Medication Dispense)
                    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                    98. Claim.item.extension:prescriberFlag
                    Slice NameprescriberFlag
                    Control0..1
                    TypeExtension(Prescriber Flag) (Extension Type: boolean)
                    100. Claim.item.extension:prescriptionFlag
                    Slice NameprescriptionFlag
                    Control0..1
                    TypeExtension(Prescription Flag) (Extension Type: boolean)
                    102. Claim.item.extension:doseFlag
                    Slice NamedoseFlag
                    Control0..1
                    TypeExtension(Dose Flag) (Extension Type: boolean)
                    104. Claim.item.extension:groupId
                    Slice NamegroupId
                    Control0..1
                    TypeExtension(Group ID) (Extension Type: string)
                    106. Claim.item.extension:transactionCategory
                    Slice NametransactionCategory
                    Control1..1
                    TypeExtension(Transaction Category) (Extension Type: CodeableConcept)
                    108. Claim.item.extension:extendedSupplyFlag
                    Slice NameextendedSupplyFlag
                    Control0..1
                    TypeExtension(Extended Supply Flag) (Extension Type: boolean)
                    110. Claim.item.revenue
                    Control0..0
                    112. Claim.item.category
                    Control0..0
                    114. Claim.item.modifier
                    Control0..0
                    116. Claim.item.programCode
                    Control0..0
                    118. Claim.item.serviced[x]
                    Control1..?
                    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                    SlicingThis element introduces a set of slices on Claim.item.serviced[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • type @ $this
                    • 120. Claim.item.serviced[x]:servicedPeriod
                      Slice NameservicedPeriod
                      Control1..1
                      TypePeriod
                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                      122. Claim.item.serviced[x]:servicedPeriod.start
                      Control1..?
                      Invariantsfull-datetime-with-timezone: DateTime must be ISO 8601 format with time and timezone (e.g., 2026-01-01T00:00:00+13:00 or 2026-01-01T00:00:00Z). Date-only values are not accepted. (toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(\\.[0-9]+)?(Z|[+-][0-9]{2}:[0-9]{2})$'))
                      124. Claim.item.serviced[x]:servicedPeriod.end
                      Control1..?
                      Invariantsfull-datetime-with-timezone: DateTime must be ISO 8601 format with time and timezone (e.g., 2026-01-01T00:00:00+13:00 or 2026-01-01T00:00:00Z). Date-only values are not accepted. (toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(\\.[0-9]+)?(Z|[+-][0-9]{2}:[0-9]{2})$'))
                      126. Claim.item.udi
                      Control0..0
                      128. Claim.item.bodySite
                      Control0..0
                      130. Claim.item.subSite
                      Control0..0
                      132. Claim.item.detail
                      Control1..?
                      134. Claim.item.detail.extension
                      SlicingThis element introduces a set of slices on Claim.item.detail.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ url
                      • 136. Claim.item.detail.extension:balanceOwing
                        Slice NamebalanceOwing
                        Control0..1
                        TypeExtension(Balance Owing) (Extension Type: string)
                        138. Claim.item.detail.extension:wastageQuantity
                        Slice NamewastageQuantity
                        Control0..1
                        TypeExtension(Wastage Quantity) (Extension Type: Quantity)
                        140. Claim.item.detail.extension:cbsSubsidy
                        Slice NamecbsSubsidy
                        Control0..1
                        TypeExtension(CBS Subsidy) (Extension Type: Money)
                        142. Claim.item.detail.extension:cbsPackSize
                        Slice NamecbsPackSize
                        Control0..1
                        TypeExtension(CBS Pack Size) (Extension Type: Quantity)
                        144. Claim.item.detail.revenue
                        Control0..0
                        146. Claim.item.detail.category
                        Control0..0
                        148. Claim.item.detail.modifier
                        Control0..0
                        150. Claim.item.detail.programCode
                        Control0..0
                        152. Claim.item.detail.quantity
                        Control1..?
                        154. Claim.item.detail.net
                        Control1..?
                        156. Claim.item.detail.udi
                        Control0..0
                        158. Claim.total
                        Control1..?

                        Guidance on how to interpret the contents of this table can be foundhere

                        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
                        Control1..1
                        TypeMeta
                        Is Modifierfalse
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        6. Claim.meta.id
                        Definition

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

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

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

                        ShortAdditional content defined by implementations
                        Comments

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

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

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

                          ShortVersion specific identifier
                          Comments

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

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

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

                          ShortWhen the resource version last changed
                          Comments

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

                          Control0..1
                          Typeinstant
                          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()))
                          14. Claim.meta.source
                          Definition

                          Captures the source of the record. This must contain the HPIFacilityID e.g. https://standards.digital.health.nz/ns/hpi-facility-id/FZZ111-A

                          ShortHPI Facility ID from where the record is sourced
                          Comments

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

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

                          Control1..1
                          Typeuri
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          hpi-location-url-format: Reference must be an HPI facility URL with format https://standards.digital.health.nz/ns/hpi-facility-id/FZZ111-A (matches('^https://standards.digital.health.nz/ns/hpi-facility-id/F[A-Za-z0-9]{2}[0-9]{3}-[A-Za-z0-9]$'))
                          16. Claim.meta.profile
                          Definition

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

                          ShortProfiles this resource claims to conform to
                          Comments

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

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

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

                          ShortSecurity Labels applied to this resource
                          Comments

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

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

                          Security Labels from the Healthcare Privacy and Security Classification System.

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

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

                          ShortTags applied to this resource
                          Comments

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

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

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

                          TypeCoding
                          Is Modifierfalse
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          SlicingThis element introduces a set of slices on Claim.meta.tag. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                          • value @ system
                          • 22. Claim.meta.tag:correlationId
                            Slice NamecorrelationId
                            Definition

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

                            ShortTags applied to this resource
                            Comments

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

                            Control1..1
                            BindingFor example codes, see CommonTags
                            (example to http://hl7.org/fhir/ValueSet/common-tags)

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

                            TypeCoding
                            Is Modifierfalse
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            24. Claim.meta.tag:correlationId.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.meta.tag:correlationId.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.meta.tag.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                            • value @ url
                            • 28. Claim.meta.tag:correlationId.system
                              Definition

                              The system URI used by the hub to identify its correlation ID.

                              ShortHub correlation ID 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.

                              Pattern Valuehttps://hub.services.digital.health.nz/ns/correlation-id
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              30. Claim.meta.tag:correlationId.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()))
                              32. Claim.meta.tag:correlationId.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()))
                              34. Claim.meta.tag:correlationId.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
                              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()))
                              36. Claim.meta.tag:correlationId.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()))
                              38. 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()))
                              40. 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)

                              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()))
                              42. 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()))
                              44. 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..0
                              TypeResource
                              Is Modifierfalse
                              Summaryfalse
                              Alternate Namesinline resources, anonymous resources, contained resources
                              46. Claim.extension
                              Definition

                              An Extension

                              ShortExtension
                              Control1..*
                              TypeExtension
                              Is Modifierfalse
                              Summaryfalse
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                              SlicingThis element introduces a set of slices on Claim.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                              • value @ url
                              • 48. Claim.extension:patientCohort
                                Slice NamepatientCohort
                                Definition

                                Indicates the cohort for which the patient belongs, such as CRC, ARRC, LTC, CDOS, PRISON, etc.

                                ShortPatient Cohort
                                Control0..1
                                This element is affected by the following invariants: ele-1
                                TypeExtension(Patient Cohort) (Extension Type: CodeableConcept)
                                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())
                                50. Claim.extension:claimantNumber
                                Slice NameclaimantNumber
                                Definition

                                The claimant number for the patient.

                                ShortClaimant Number
                                Control1..1
                                This element is affected by the following invariants: ele-1
                                TypeExtension(Claimant Number) (Extension Type: string)
                                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())
                                52. Claim.extension:originatingClaimantNumber
                                Slice NameoriginatingClaimantNumber
                                Definition

                                The claimant number for the the previous owner.

                                ShortOriginating Claimant Number
                                Control0..1
                                This element is affected by the following invariants: ele-1
                                TypeExtension(Originating Claimant Number) (Extension Type: string)
                                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())
                                54. 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())
                                56. Claim.identifier
                                Definition

                                A unique identifier assigned to this claim.

                                ShortBusiness Identifier for claim
                                NoteThis is a business identifier, not a resource identifier (see discussion)
                                Control1..*
                                TypeIdentifier
                                Is Modifierfalse
                                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()))
                                58. 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
                                60. 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
                                • 62. 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()))
                                  64. 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)

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

                                  ExampleGeneral: http://www.acme.com/identifiers/patient
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  68. 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()))
                                  70. 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()))
                                  72. 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()))
                                  74. 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'.

                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  76. 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 NZ Claim Types
                                  (extensible to https://fhir-ig.digital.health.nz/shared-care/ValueSet/nz-claim-types)
                                  TypeCodeableConcept
                                  Is Modifierfalse
                                  Summarytrue
                                  Requirements

                                  Claim type determine the general sets of business rules applied for information requirements and adjudication.

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

                                  Control1..1
                                  BindingUnless not suitable, these codes SHALL be taken from NZ Claim Subtypes
                                  (extensible to https://fhir-ig.digital.health.nz/shared-care/ValueSet/nz-claim-subtypes)
                                  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()))
                                  80. 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.

                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  82. 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(NZ Patient, Patient)
                                  Is Modifierfalse
                                  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()))
                                  84. Claim.patient.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
                                  86. Claim.patient.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.patient.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                  • value @ url
                                  • 88. Claim.patient.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..1
                                    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()))
                                    90. Claim.patient.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.

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

                                    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
                                    Pattern ValuePatient
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    92. Claim.patient.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)
                                    Control1..1
                                    TypeIdentifier
                                    Is Modifierfalse
                                    Summarytrue
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    94. Claim.patient.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
                                    96. Claim.patient.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.patient.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                    • value @ url
                                    • 98. Claim.patient.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()))
                                      100. Claim.patient.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)

                                      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()))
                                      102. Claim.patient.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 Valuehttps://standards.digital.health.nz/ns/nhi-id
                                      ExampleGeneral: http://www.acme.com/identifiers/patient
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      104. Claim.patient.identifier.value
                                      Definition

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

                                      ShortMust be an absolute URL reference to the patient on the NHI system. See constraints for details.
                                      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()))
                                      nhi-value-format: Reference must be an NHI Patient URL with format ZZZ1111 or ZZZ11AA (matches('^[A-Z]{3}([0-9]{4}|[0-9]{2}[A-Z]{2})$'))
                                      106. Claim.patient.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()))
                                      108. Claim.patient.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()))
                                      110. Claim.patient.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.

                                      Control0..0
                                      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()))
                                      112. 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.

                                      Control1..1
                                      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()))
                                      114. Claim.billablePeriod.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
                                      116. Claim.billablePeriod.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.billablePeriod.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                      • value @ url
                                      • 118. Claim.billablePeriod.start
                                        Definition

                                        The start of the period. The boundary is inclusive.

                                        ShortStarting time with inclusive boundary
                                        Comments

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

                                        Control1..1
                                        This element is affected by the following invariants: per-1
                                        TypedateTime
                                        Is Modifierfalse
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Summarytrue
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        date-only: DateTime must be date-only in yyyy-mm-dd format. Time and timezone values are not accepted. (toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}$'))
                                        120. Claim.billablePeriod.end
                                        Definition

                                        The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

                                        ShortEnd time with inclusive boundary, if not ongoing
                                        Comments

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

                                        Control1..1
                                        This element is affected by the following invariants: per-1
                                        TypedateTime
                                        Is Modifierfalse
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Summarytrue
                                        Meaning if MissingIf the end of the period is missing, it means that the period is ongoing
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        date-only: DateTime must be date-only in yyyy-mm-dd format. Time and timezone values are not accepted. (toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}$'))
                                        122. 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
                                        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()))
                                        full-datetime-with-timezone: DateTime must be ISO 8601 format with time and timezone (e.g., 2026-01-01T00:00:00+13:00 or 2026-01-01T00:00:00Z). Date-only values are not accepted. (toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(\\.[0-9]+)?(Z|[+-][0-9]{2}:[0-9]{2})$'))
                                        124. Claim.enterer
                                        Definition

                                        Individual who created the claim, predetermination or preauthorization.

                                        ShortAuthor of the claim
                                        Control0..1
                                        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()))
                                        126. 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()))
                                        128. Claim.provider
                                        Definition

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

                                        ShortParty responsible for the claim
                                        Comments

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

                                        Control1..1
                                        TypeReference(Organization)
                                        Is Modifierfalse
                                        Summarytrue
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        130. Claim.provider.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
                                        132. Claim.provider.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.provider.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                        • value @ url
                                        • 134. Claim.provider.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..1
                                          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()))
                                          136. Claim.provider.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)

                                          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()))
                                          138. Claim.provider.identifier
                                          Definition

                                          A local identifier MUST be added to this section to correlate the organization, facility or nzbn.

                                          ShortA local identifier MUST be added to this section.
                                          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)
                                          Control1..1
                                          TypeIdentifier
                                          Is Modifierfalse
                                          Summarytrue
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          hpiOrganizationIdPattern: HPI Organisation ID must conform to format (GXXnnn-C). (system = 'https://standards.digital.health.nz/ns/hpi-organisation-id' implies value.matches('^G[a-zA-Z0-9]{2}[0-9]{3}-[a-zA-Z0-9]$'))
                                          hpiFacilityIdPattern: HPI Facility ID must conform to format (FXXnnn-C). (system = 'https://standards.digital.health.nz/ns/hpi-facility-id' implies value.matches('^F[A-Za-z0-9]{2}[0-9]{3}-[A-Za-z0-9]$'))
                                          nzbnPattern: NZBN must conform to format (13 digits). (system = 'https://standards.digital.health.nz/ns/hpi-nzbn' implies value.matches('^[0-9]{13}$'))
                                          hpiCpnPattern: HPI CPN must conform to format (NNXXXX where N is numeric and X is alphabetic). (system = 'https://standards.digital.health.nz/ns/hpi-person-id' implies value.matches('^[0-9]{2}[A-Za-z]{4}$'))
                                          140. Claim.provider.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
                                          142. Claim.provider.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.provider.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                          • value @ url
                                          • 144. Claim.provider.identifier.use
                                            Definition

                                            The purpose of this identifier.

                                            ShortThe local identifier use SHOULD be set to official.
                                            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()))
                                            146. Claim.provider.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)

                                            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()))
                                            148. Claim.provider.identifier.system
                                            Definition

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

                                            ShortThe system identifier for the organization, facility or nzbn
                                            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.

                                            ExampleGeneral: http://www.acme.com/identifiers/patient
                                            HPI Organisation ID: https://standards.digital.health.nz/ns/hpi-organisation-id
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            allowedLocalIdentifierSystems: Identifier system must be HPI facility, HPI Organisation, HPI CPN or NZBN ($this = 'https://standards.digital.health.nz/ns/hpi-organisation-id' or $this = 'https://standards.digital.health.nz/ns/hpi-nzbn' or $this = 'https://standards.digital.health.nz/ns/hpi-facility-id' or $this = 'https://standards.digital.health.nz/ns/hpi-person-id')
                                            150. Claim.provider.identifier.value
                                            Definition

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

                                            ShortThe actual local identifier value, e.g. GZZ999-Z
                                            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
                                            Example HPI Org ID: GZZ999-Z
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            152. Claim.provider.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()))
                                            154. Claim.provider.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()))
                                            156. Claim.provider.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.

                                            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()))
                                            158. 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
                                            BindingThe codes SHALL be taken from ProcessPriorityCodes
                                            (required to http://hl7.org/fhir/ValueSet/process-priority)
                                            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.

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

                                            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()))
                                            162. 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..*
                                            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()))
                                            164. Claim.related.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
                                            166. Claim.related.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())
                                            168. Claim.related.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())
                                            170. Claim.related.claim
                                            Definition

                                            Reference to a related claim.

                                            ShortReference to the related claim
                                            Control0..1
                                            TypeReference(Claim)
                                            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()))
                                            172. Claim.related.relationship
                                            Definition

                                            A code to convey how the claims are related.

                                            ShortHow the reference claim is related
                                            Comments

                                            For example, prior claim or umbrella.

                                            Control0..1
                                            BindingFor example codes, see ExampleRelatedClaimRelationshipCodes
                                            (example to http://hl7.org/fhir/ValueSet/related-claim-relationship)

                                            Relationship of this claim to a related Claim.

                                            TypeCodeableConcept
                                            Is Modifierfalse
                                            Summaryfalse
                                            Requirements

                                            Some insurers need a declaration of the type of relationship.

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

                                            An alternate organizational reference to the case or file to which this particular claim pertains.

                                            ShortFile or case reference
                                            Comments

                                            For example, Property/Casualty insurer claim # or Workers Compensation case # .

                                            Control0..1
                                            TypeIdentifier
                                            Is Modifierfalse
                                            Summaryfalse
                                            Requirements

                                            In cases where an event-triggered claim is being submitted to an insurer which requires a reference number to be specified on all exchanges.

                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            176. 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()))
                                            178. 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()))
                                            180. 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()))
                                            187. Claim.referral
                                            Definition

                                            A reference to a referral resource.

                                            ShortTreatment referral
                                            Comments

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

                                            Control0..1
                                            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()))
                                            189. Claim.facility
                                            Definition

                                            Facility where the services were provided.

                                            ShortServicing facility
                                            Control0..1
                                            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()))
                                            191. 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()))
                                            201. 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.

                                            Control0..*
                                            TypeBackboneElement
                                            Is Modifierfalse
                                            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()))
                                            203. 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
                                            205. 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())
                                            207. 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())
                                            209. 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()))
                                            211. 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)

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

                                            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()))
                                            215. 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()))
                                            217. 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()))
                                            219. 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)

                                            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()))
                                            221. 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()))
                                            231. 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()))
                                            241. Claim.insurance
                                            Definition

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

                                            ShortPatient insurance information
                                            Comments

                                            All insurance coverages for the patient which may be applicable for reimbursement, of the products and services listed in the claim, are typically provided in the claim to allow insurers to confirm the ordering of the insurance coverages relative to local 'coordination of benefit' rules. One coverage (and only one) with 'focal=true' is to be used in the adjudication of this claim. Coverages appearing before the focal Coverage in the list, and where '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()))
                                            243. 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
                                            245. 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())
                                            247. 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())
                                            249. 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.

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

                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            253. 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..1
                                            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()))
                                            255. 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()))
                                            257. 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..1
                                            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()))
                                            259. 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..*
                                            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()))
                                            261. 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..1
                                            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()))
                                            263. 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()))
                                            271. 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.

                                            ShortProduct or service provided
                                            Control1..*
                                            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()))
                                            273. 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
                                            275. Claim.item.extension
                                            Definition

                                            An Extension

                                            ShortExtension
                                            Control2..*
                                            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.item.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                            • value @ url
                                            • 277. Claim.item.extension:patientFlag
                                              Slice NamepatientFlag
                                              Definition

                                              Indicates a flag relevant to the patient for the pharmacy claim.

                                              ShortPatient Flag
                                              Control0..1
                                              This element is affected by the following invariants: ele-1
                                              TypeExtension(Patient Flag) (Extension Type: boolean)
                                              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())
                                              279. Claim.item.extension:request
                                              Slice Namerequest
                                              Definition

                                              Reference from a pharmacy claim item to the MedicationDispense that supports the claim item.

                                              ShortItem Request
                                              Control1..1
                                              This element is affected by the following invariants: ele-1
                                              TypeExtension(Item Request) (Extension Type: Reference(MedicationDispense))
                                              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())
                                              281. Claim.item.extension:request.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
                                              283. Claim.item.extension:request.extension
                                              Definition

                                              An Extension

                                              ShortExtension
                                              Control0..0
                                              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.item.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                              • value @ url
                                              • 285. Claim.item.extension:request.url
                                                Definition

                                                Source of the definition for the extension code - a logical name or a URL.

                                                Shortidentifies the meaning of the extension
                                                Comments

                                                The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                                Control1..1
                                                Typeuri
                                                Is Modifierfalse
                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                Summaryfalse
                                                Fixed Valuehttps://fhir-ig.digital.health.nz/shared-care/StructureDefinition/item-request
                                                287. Claim.item.extension:request.value[x]
                                                Definition

                                                Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                                ShortValue of extension
                                                Control1..1
                                                TypeReference(NZ Medication Dispense)
                                                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                Is Modifierfalse
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                289. Claim.item.extension:prescriberFlag
                                                Slice NameprescriberFlag
                                                Definition

                                                Indicates a flag relevant to the prescriber for the pharmacy claim.

                                                ShortPrescriber Flag
                                                Control0..1
                                                This element is affected by the following invariants: ele-1
                                                TypeExtension(Prescriber Flag) (Extension Type: boolean)
                                                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())
                                                291. Claim.item.extension:prescriptionFlag
                                                Slice NameprescriptionFlag
                                                Definition

                                                Indicates a flag relevant to the prescription for the pharmacy claim.

                                                ShortPrescription Flag
                                                Control0..1
                                                This element is affected by the following invariants: ele-1
                                                TypeExtension(Prescription Flag) (Extension Type: boolean)
                                                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())
                                                293. Claim.item.extension:doseFlag
                                                Slice NamedoseFlag
                                                Definition

                                                Indicates a flag relevant to the dose for the pharmacy claim.

                                                ShortDose Flag
                                                Control0..1
                                                This element is affected by the following invariants: ele-1
                                                TypeExtension(Dose Flag) (Extension Type: boolean)
                                                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())
                                                295. Claim.item.extension:groupId
                                                Slice NamegroupId
                                                Definition

                                                A group identifier relevant to the pharmacy claim.

                                                ShortGroup ID
                                                Control0..1
                                                This element is affected by the following invariants: ele-1
                                                TypeExtension(Group ID) (Extension Type: string)
                                                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())
                                                297. Claim.item.extension:transactionCategory
                                                Slice NametransactionCategory
                                                Definition

                                                The pharmacy claim transaction category.

                                                ShortTransaction Category
                                                Control1..1
                                                This element is affected by the following invariants: ele-1
                                                TypeExtension(Transaction Category) (Extension Type: CodeableConcept)
                                                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())
                                                299. Claim.item.extension:extendedSupplyFlag
                                                Slice NameextendedSupplyFlag
                                                Definition

                                                Indicates whether the pharmacy claim item relates to extended supply.

                                                ShortExtended Supply Flag
                                                Control0..1
                                                This element is affected by the following invariants: ele-1
                                                TypeExtension(Extended Supply Flag) (Extension Type: boolean)
                                                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())
                                                301. 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())
                                                303. 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()))
                                                305. Claim.item.careTeamSequence
                                                Definition

                                                CareTeam members related to this service or product.

                                                ShortApplicable careTeam members
                                                Control0..*
                                                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()))
                                                307. Claim.item.diagnosisSequence
                                                Definition

                                                Diagnosis applicable for this service or product.

                                                ShortApplicable diagnoses
                                                Control0..*
                                                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()))
                                                309. Claim.item.procedureSequence
                                                Definition

                                                Procedures applicable for this service or product.

                                                ShortApplicable procedures
                                                Control0..*
                                                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()))
                                                311. Claim.item.informationSequence
                                                Definition

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

                                                ShortApplicable exception and supporting information
                                                Control0..*
                                                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()))
                                                313. 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)

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

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

                                                Allowable service and product codes.

                                                TypeCodeableConcept
                                                Is Modifierfalse
                                                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()))
                                                319. 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)

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

                                                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()))
                                                323. 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
                                                Control1..1
                                                TypePeriod
                                                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                Is Modifierfalse
                                                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()))
                                                SlicingThis element introduces a set of slices on Claim.item.serviced[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                                                • type @ $this
                                                • 325. Claim.item.serviced[x]:servicedPeriod
                                                  Slice NameservicedPeriod
                                                  Definition

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

                                                  ShortDate or dates of service or product delivery
                                                  Control1..1
                                                  TypePeriod
                                                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                  Is Modifierfalse
                                                  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()))
                                                  327. Claim.item.serviced[x]:servicedPeriod.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
                                                  329. Claim.item.serviced[x]:servicedPeriod.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.serviced[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                  • value @ url
                                                  • 331. Claim.item.serviced[x]:servicedPeriod.start
                                                    Definition

                                                    The start of the period. The boundary is inclusive.

                                                    ShortStarting time with inclusive boundary
                                                    Comments

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

                                                    Control1..1
                                                    This element is affected by the following invariants: per-1
                                                    TypedateTime
                                                    Is Modifierfalse
                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                    Summarytrue
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    full-datetime-with-timezone: DateTime must be ISO 8601 format with time and timezone (e.g., 2026-01-01T00:00:00+13:00 or 2026-01-01T00:00:00Z). Date-only values are not accepted. (toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(\\.[0-9]+)?(Z|[+-][0-9]{2}:[0-9]{2})$'))
                                                    333. Claim.item.serviced[x]:servicedPeriod.end
                                                    Definition

                                                    The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

                                                    ShortEnd time with inclusive boundary, if not ongoing
                                                    Comments

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

                                                    Control1..1
                                                    This element is affected by the following invariants: per-1
                                                    TypedateTime
                                                    Is Modifierfalse
                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                    Summarytrue
                                                    Meaning if MissingIf the end of the period is missing, it means that the period is ongoing
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    full-datetime-with-timezone: DateTime must be ISO 8601 format with time and timezone (e.g., 2026-01-01T00:00:00+13:00 or 2026-01-01T00:00:00Z). Date-only values are not accepted. (toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(\\.[0-9]+)?(Z|[+-][0-9]{2}:[0-9]{2})$'))
                                                    335. Claim.item.location[x]
                                                    Definition

                                                    Where the product or service was provided.

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

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

                                                    TypeChoice of: CodeableConcept, Address, Reference(Location)
                                                    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                    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()))
                                                    337. 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()))
                                                    339. 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..1
                                                    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()))
                                                    341. 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..1
                                                    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()))
                                                    343. 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..1
                                                    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()))
                                                    345. 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()))
                                                    347. 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)

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

                                                    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()))
                                                    351. 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..*
                                                    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()))
                                                    353. 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
                                                    Control1..*
                                                    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()))
                                                    355. Claim.item.detail.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
                                                    357. Claim.item.detail.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.item.detail.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                    • value @ url
                                                    • 359. Claim.item.detail.extension:balanceOwing
                                                      Slice NamebalanceOwing
                                                      Definition

                                                      Indicates the balance owing for the pharmacy claim item detail.

                                                      ShortBalance Owing
                                                      Control0..1
                                                      This element is affected by the following invariants: ele-1
                                                      TypeExtension(Balance Owing) (Extension Type: string)
                                                      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())
                                                      361. Claim.item.detail.extension:wastageQuantity
                                                      Slice NamewastageQuantity
                                                      Definition

                                                      Indicates the wastage quantity for the pharmacy claim item detail.

                                                      ShortWastage Quantity
                                                      Control0..1
                                                      This element is affected by the following invariants: ele-1
                                                      TypeExtension(Wastage Quantity) (Extension Type: Quantity)
                                                      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())
                                                      363. Claim.item.detail.extension:cbsSubsidy
                                                      Slice NamecbsSubsidy
                                                      Definition

                                                      Indicates the CBS subsidy for the pharmacy claim item detail.

                                                      ShortCBS Subsidy
                                                      Control0..1
                                                      This element is affected by the following invariants: ele-1
                                                      TypeExtension(CBS Subsidy) (Extension Type: Money)
                                                      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())
                                                      365. Claim.item.detail.extension:cbsPackSize
                                                      Slice NamecbsPackSize
                                                      Definition

                                                      Indicates the CBS pack size for the pharmacy claim item detail.

                                                      ShortCBS Pack Size
                                                      Control0..1
                                                      This element is affected by the following invariants: ele-1
                                                      TypeExtension(CBS Pack Size) (Extension Type: Quantity)
                                                      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())
                                                      367. Claim.item.detail.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())
                                                      369. Claim.item.detail.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()))
                                                      371. Claim.item.detail.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)

                                                      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()))
                                                      373. Claim.item.detail.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)

                                                      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()))
                                                      375. Claim.item.detail.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)

                                                      Allowable service and product codes.

                                                      TypeCodeableConcept
                                                      Is Modifierfalse
                                                      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()))
                                                      377. Claim.item.detail.modifier
                                                      Definition

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

                                                      ShortService/Product 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 out of office hours.

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

                                                      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()))
                                                      379. Claim.item.detail.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)

                                                      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()))
                                                      381. Claim.item.detail.quantity
                                                      Definition

                                                      The number of repetitions of a service or product.

                                                      ShortCount of products or services
                                                      Control1..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()))
                                                      383. Claim.item.detail.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..1
                                                      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()))
                                                      385. Claim.item.detail.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..1
                                                      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()))
                                                      387. Claim.item.detail.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.

                                                      Control1..1
                                                      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()))
                                                      389. Claim.item.detail.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()))
                                                      391. Claim.item.detail.subDetail
                                                      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..*
                                                      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()))
                                                      393. Claim.item.detail.subDetail.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
                                                      395. Claim.item.detail.subDetail.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())
                                                      397. Claim.item.detail.subDetail.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())
                                                      399. Claim.item.detail.subDetail.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()))
                                                      401. Claim.item.detail.subDetail.revenue
                                                      Definition

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

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

                                                      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()))
                                                      403. Claim.item.detail.subDetail.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..1
                                                      BindingFor example codes, see BenefitCategoryCodes
                                                      (example to http://hl7.org/fhir/ValueSet/ex-benefitcategory)

                                                      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()))
                                                      405. Claim.item.detail.subDetail.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)

                                                      Allowable service and product codes.

                                                      TypeCodeableConcept
                                                      Is Modifierfalse
                                                      Summaryfalse
                                                      Requirements

                                                      Necessary to state what was provided or done.

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

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

                                                      ShortService/Product 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 out of office hours.

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

                                                      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()))
                                                      409. Claim.item.detail.subDetail.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..*
                                                      BindingFor example codes, see ExampleProgramReasonCodes
                                                      (example to http://hl7.org/fhir/ValueSet/ex-program-code)

                                                      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()))
                                                      411. Claim.item.detail.subDetail.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()))
                                                      413. Claim.item.detail.subDetail.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..1
                                                      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()))
                                                      415. Claim.item.detail.subDetail.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..1
                                                      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()))
                                                      417. Claim.item.detail.subDetail.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..1
                                                      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()))
                                                      419. Claim.item.detail.subDetail.udi
                                                      Definition

                                                      Unique Device Identifiers associated with this line item.

                                                      ShortUnique device identifier
                                                      Control0..*
                                                      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()))
                                                      421. Claim.total
                                                      Definition

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

                                                      ShortTotal claim cost
                                                      Control1..1
                                                      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()))