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

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

Active as of 2026-03-03

Definitions for the SharedCareClaim resource profile.

- Key Elements Table
- Differential Elements Table
- Snapshot Elements Table

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.
Short | Claim, 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.
Control | 0..*
Is Modifier | false
Summary | false
Alternate Names | Adjudication Request, Preauthorization Request, Predetermination Request
Invariants | dom-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.
Short | Metadata about the resource
Control | 10..1
Type | Meta
Is Modifier | false
Summary | true
Invariants | ele-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.
Short | HPI 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.
Control | 10..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-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.
Short | Profiles 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.
Control | 10..1*
Type | canonical(StructureDefinition)
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-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.
Short | Tags 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.
Control | 10..*
Binding | For example codes, see CommonTags http://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".
Type | Coding
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing | This 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 Name | correlationId
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.
Short | Tags 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.
Control | 10..1*
Binding | For example codes, see CommonTags http://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".
Type | Coding
Is Modifier | false
Summary | true
Invariants | ele-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.
Short | Hub 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.
Control | 10..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Pattern Value | `https://hub.services.digital.health.nz/ns/correlation-id`
Invariants | ele-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).
Short | Symbol in syntax defined by the system
Control | 10..1
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to refer to a particular code in the system.
Invariants | ele-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.
Short | A 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.
Control | 0..1
Type | uri
Is Modifier | true 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 Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-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.
Short | Contained, 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.
Control | 0..0*
Type | Resource
Is Modifier | false
Summary | false
Alternate Names | inline 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.
Short | ExtensionAdditional 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.
Control | 10..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-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())
Slicing | This 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:traceNumber
Slice Name | traceNumber
Definition | Internal primary key ID for shared care claim tracking
Short | Shared Care Claim Trace Number
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(Shared Care Claim Trace Number) (Extension Type: Identifier)
Is Modifier | false
Summary | false
Invariants | ele-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:agreementNumber
Slice Name | agreementNumber
Definition | The agreement/contract number between the provider and the 'insurer' (HNZ) including version number
Short | Shared Care Agreement Number
Control | 1..1 This element is affected by the following invariants: ele-1
Type | Extension(Shared Care Agreement Number) (Extension Type: string)
Is Modifier | false
Summary | false
Invariants | ele-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.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).
Short | Extensions 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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summary | false
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 Names | extensions, user content
Invariants | ele-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())
28. Claim.identifier
Definition | A unique identifier assigned to this claim.
Short | Business identifier(s) for the claimBusiness Identifier for claim
Comments | Business identifier(s) for the claim (external and/or internal identifiers). The system should be the practice/organisation with the PMS (e.g., https://provider-org-name.co.nz/ns/claim-identifier). The value is in the context/namespace of that system, not Health NZ. Integrators should come up with their own system.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
Is Modifier | false
Summary | false
Requirements | Allows claims to be distinguished and referenced.
Alternate Names | Claim Number
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. Claim.identifier.use
Definition | The purpose of this identifier.
Short | usual | official | temp | secondary | old (If known)
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Control | 0..1
Binding | The codes SHALL be taken from IdentifierUse http://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 .
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. Claim.identifier.system
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Short | The namespace for the identifier value
Comments | Identifier.system is always case sensitive.
Control | 10..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
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.
Example | General: http://www.acme.com/identifiers/patient
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
34. Claim.identifier.value
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Short | 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.
Control | 10..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Example | General: 123456
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. Claim.status
Definition | The status of the resource instance.
Short | active | 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.
Control | 1..1
Binding | The codes SHALL be taken from FinancialResourceStatusCodes http://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.
Type | code
Is Modifier | true 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 Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
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'.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. Claim.type
Definition | The category of claim, e.g. oral, pharmacy, vision, institutional, professional.
Short | Claim typeCategory 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.
Control | 1..1
Binding | Unless not suitable, these codes SHALL be taken from NZ Claim Types http://hl7.org/fhir/ValueSet/claim-type (extensible to `https://fhir-ig.digital.health.nz/shared-care/ValueSet/nz-claim-types` )
Type | CodeableConcept
Is Modifier | false
Summary | true
Requirements | Claim type determine the general sets of business rules applied for information requirements and adjudication.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
40. 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.
Short | Claim subtypeMore 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.
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from For example codes, see NZ Claim Subtypes http://hl7.org/fhir/ValueSet/claim-subtype (extensible to `https://fhir-ig.digital.health.nz/shared-care/ValueSet/nz-claim-subtypes` )
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Some jurisdictions need a finer grained claim type for routing and adjudication.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
42. 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.
Short | claim | preauthorization | predetermination
Control | 1..1
Binding | The codes SHALL be taken from Use http://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.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | This element is required to understand the nature of the request for adjudication.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
44. 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.
Short | The recipient of the products and services
Control | 1..1
Type | Reference(NZ Patient, Patient)
Is Modifier | false
Summary | true
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.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
46. 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).
Short | Type 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.
Control | 10..1
Binding | Unless not suitable, these codes SHALL be taken from ResourceType http://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).
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Pattern Value | `Patient`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
48. 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.
Short | 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).
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 10..1
Type | Identifier
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
50. Claim.patient.identifier.use
Definition | The purpose of this identifier.
Short | usual | official | temp | secondary | old (If known)
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Control | 0..1
Binding | The codes SHALL be taken from IdentifierUse http://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 .
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
52. Claim.patient.identifier.system
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Short | The namespace for the identifier value
Comments | Identifier.system is always case sensitive.
Control | 10..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Fixed Value | `https://standards.digital.health.nz/ns/nhi-id`
Example | General: http://www.acme.com/identifiers/patient
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
54. 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.
Short | Must 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.
Control | 10..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Example | General: 123456
Invariants | ele-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})$')`)
56. Claim.patient.display
Definition | Plain text narrative that identifies the resource in addition to the resource reference.
Short | Text 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.
Control | 0..01
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
58. Claim.billablePeriod
Definition | The period for which charges are being submitted.
Short | Billing period with datetime including timezone (start is inclusive, end is exclusive)Relevant time frame for the claim
Comments | The start time is inclusive, end time is exclusive. The end datetime (converted to an inclusive local date) is used as the Claim Date and/or end of the claim period. 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.
Control | 10..1
Type | Period
Is Modifier | false
Summary | true
Requirements | A number jurisdictions required the submission of the billing period when submitting claims for example for hospital stays or long-term care.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
60. Claim.created
Definition | The date this resource was created.
Short | Resource 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.
Control | 1..1
Type | dateTime
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to record a timestamp for use by both the recipient and the issuer.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
62. Claim.insurer
Definition | The Insurer who is target of the request.
Short | Target
Control | 0..01
Type | Reference(Organization)
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
64. Claim.provider
Definition | The provider which is responsible for the claim, predetermination or preauthorization.
Short | Legal entity who submitted the claimParty responsible for the claim
Comments | Legal entity who submitted the claim - identifiable by its HPI identifier (or also its NZBN) 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.
Control | 1..1
Type | Reference(Organization, Practitioner, PractitionerRole)
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
66. 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.
Short | A 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).
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 10..1
Type | Identifier
Is Modifier | false
Summary | true
Invariants | ele-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}$')`)
68. Claim.provider.identifier.use
Definition | The purpose of this identifier.
Short | The 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.
Control | 0..1
Binding | The codes SHALL be taken from IdentifierUse http://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 .
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
70. Claim.provider.identifier.system
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Short | The system identifier for the organization, facility or nzbnThe namespace for the identifier value
Comments | Identifier.system is always case sensitive.
Control | 10..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
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.
Example | General: http://www.acme.com/identifiers/patient HPI Organisation ID: https://standards.digital.health.nz/ns/hpi-organisation-id
Invariants | ele-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'`)
72. 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.
Short | The 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.
Control | 10..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Example | General: 123456 Example HPI Org ID: GZZ999-Z
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
74. Claim.priority
Definition | The provider-required urgency of processing the request. Typical values include: stat, routine deferred.
Short | Desired 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.
Control | 1..1
Binding | For example codes, see ProcessPriorityCodes http://hl7.org/fhir/ValueSet/process-priority (example to `http://hl7.org/fhir/ValueSet/process-priority` ) The timeliness with which processing is required: stat, normal, deferred.
Type | CodeableConcept
Is Modifier | false
Summary | true
Requirements | The provider may need to indicate their processing requirements so that the processor can indicate if they are unable to comply.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
76. Claim.fundsReserve
Definition | A code to indicate whether and for whom funds are to be reserved for future claims.
Short | For whom to reserve funds
Comments | This field is only used for preauthorizations.
Control | 0..01
Binding | For example codes, see Funds Reservation Codes http://hl7.org/fhir/ValueSet/fundsreserve (example to `http://hl7.org/fhir/ValueSet/fundsreserve` ) For whom funds are to be reserved: (Patient, Provider, None).
Type | CodeableConcept
Is Modifier | false
Summary | false
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 Names | Fund pre-allocation
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
78. Claim.prescription
Definition | Prescription to support the dispensing of pharmacy, device or vision products.
Short | Prescription authorizing services and products
Control | 0..01
Type | Reference(DeviceRequest, MedicationRequest, VisionPrescription)
Is Modifier | false
Summary | false
Requirements | Required to authorize the dispensing of controlled substances and devices.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
80. Claim.originalPrescription
Definition | Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products.
Short | Original 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'.
Control | 0..01
Type | Reference(DeviceRequest, MedicationRequest, VisionPrescription)
Is Modifier | false
Summary | false
Requirements | Often required when a fulfiller varies what is fulfilled from that authorized on the original prescription.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
82. Claim.payee
Definition | The party to be reimbursed for cost of the products and services according to the terms of the policy.
Short | Recipient 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.
Control | 0..01
Type | BackboneElement
Is Modifier | false
Summary | false
Requirements | The provider needs to specify who they wish to be reimbursed and the claims processor needs express who they will reimburse.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
86. Claim.careTeam
Definition | The members of the team who provided the products and services.
Short | Members of the care team
Control | 0..0*
Type | BackboneElement
Is Modifier | false
Summary | false
Requirements | Common to identify the responsible and supporting practitioners.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
91. Claim.supportingInfo
Definition | Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues.
Short | Additional attributes that may accompany a ClaimSupporting information
Comments | Additional attributes that may accompany a Claim including categorisation, coding, date or time, value, and reason. Often there are multiple jurisdiction specific valuesets which are required.
Control | 0..*
Type | BackboneElement
Is Modifier | false
Summary | false
Requirements | Typically these information codes are required to support the services rendered or the adjudication of the services rendered.
Alternate Names | Attachments Exception Codes Occurrence Codes Value codes
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
93. 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).
Short | Extensions 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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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 Names | extensions, user content, modifiers
Invariants | ele-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())
95. Claim.supportingInfo.sequence
Definition | A number to uniquely identify supporting information entries.
Short | Information instance identifier
Control | 1..1
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Necessary to maintain the order of the supporting information items and provide a mechanism to link to claim details.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
97. Claim.supportingInfo.category
Definition | The general class of the information supplied: information; exception; accident, employment; onset, etc.
Short | Classification of the supplied information
Comments | This may contain a category for the local bill type codes.
Control | 1..1
Binding | For example codes, see ClaimInformationCategoryCodes http://hl7.org/fhir/ValueSet/claim-informationcategory (example to `http://hl7.org/fhir/ValueSet/claim-informationcategory` ) The valuset used for additional information category codes.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Required to group or associate information items with common characteristics. For example: admission information or prior treatments.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
99. Claim.diagnosis
Definition | Information about diagnoses relevant to the claim items.
Short | Pertinent diagnosis information
Control | 0..0*
Type | BackboneElement
Is Modifier | false
Summary | false
Requirements | Required for the adjudication by provided context for the services and product listed.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
104. Claim.procedure
Definition | Procedures performed on the patient relevant to the billing items with the claim.
Short | Clinical procedures performed
Control | 0..0*
Type | BackboneElement
Is Modifier | false
Summary | false
Requirements | The specific clinical invention are sometimes required to be provided to justify billing a greater than customary amount for a service.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
109. Claim.insurance
Definition | Financial instruments for reimbursement for the health care products and services specified on the claim.
Short | Patient 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.
Control | 1..1*
Type | BackboneElement
Is Modifier | false
Summary | true
Requirements | At least one insurer is required for a claim to be a claim.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
111. 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).
Short | Extensions 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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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 Names | extensions, user content, modifiers
Invariants | ele-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())
113. Claim.insurance.sequence
Definition | A number to uniquely identify insurance entries and provide a sequence of coverages to convey coordination of benefit order.
Short | Insurance instance identifier
Control | 1..1
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | To maintain order of the coverages.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
115. Claim.insurance.focal
Definition | A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true.
Short | Coverage 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.
Control | 1..1
Type | boolean
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | To identify which coverage in the list is being used to adjudicate this claim.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
117. 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.
Short | Insurance information
Control | 1..1
Type | Reference(Coverage)
Is Modifier | false
Summary | true
Requirements | Required to allow the adjudicator to locate the correct policy and history within their information system.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
119. Claim.accident
Definition | Details of an accident which resulted in injuries which required the products and services listed in the claim.
Short | Details of the event
Control | 0..01
Type | BackboneElement
Is Modifier | false
Summary | false
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.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
123. 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.
Short | Each individual product or service being claimed for as part of this claimProduct or service provided
Control | 0..*
Type | BackboneElement
Is Modifier | false
Summary | false
Requirements | The items to be processed for adjudication.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
125. 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.
Short | ExtensionAdditional 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-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())
Slicing | This 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
127. Claim.item.extension:patientPaid
Slice Name | patientPaid
Definition | Co-payment amount paid by patient for shared care services
Short | Shared Care Patient Copayment
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(Shared Care Patient Copayment) (Extension Type: Money)
Is Modifier | false
Summary | false
Invariants | ele-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.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).
Short | Extensions 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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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 Names | extensions, user content, modifiers
Invariants | ele-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())
131. Claim.item.sequence
Definition | A number to uniquely identify item entries.
Short | Referred to by the ClaimResponse.item.itemSequenceItem instance identifier
Control | 1..1
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | false
Requirements | Necessary to provide a mechanism to link to items from within the claim and within the adjudication details of the ClaimResponse.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
133. 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.
Short | Product or service being claimed (e.g., PU code)Billing, service, product, or drug code
Comments | Use actual PU codes (e.g., COGP0068) and align servicedPeriod with the code for realistic examples 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'.
Control | 1..1
Binding | For example codes, see USCLSCodes http://hl7.org/fhir/ValueSet/service-uscls (example to `http://hl7.org/fhir/ValueSet/service-uscls` ) Allowable service and product codes.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Necessary to state what was provided or done.
Alternate Names | Drug Code, Bill Code, Service Code
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
135. Claim.item.serviced[x]
Definition | The date or dates when the service or product was supplied, performed or completed.
Short | When the claimed event started and endedDate or dates of service or product delivery
Comments | This may determine the applicable fee that should have been charged and possibly the PU code that applies
Control | 0..1
Type | Period, date
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | false
Requirements | Needed to determine whether the service or product was provided during the term of the insurance coverage.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
137. Claim.item.location[x]
Definition | Where the product or service was provided.
Short | Place of service or where product was supplied
Control | 0..1
Binding | For example codes, see ExampleServicePlaceCodes http://hl7.org/fhir/ValueSet/service-place (example to `http://hl7.org/fhir/ValueSet/service-place` ) Place of service: pharmacy, school, prison, etc.
Type | Choice of: CodeableConcept, Address, Reference(Location)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | false
Requirements | The location can alter whether the item was acceptable for insurance purposes or impact the determination of the benefit amount.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on `Claim.item.location[x]`. The slices areUnordered and Open, and can be differentiated using the following discriminators: type @ $this
139. Claim.item.location[x]:locationReference
Slice Name | locationReference
Definition | Where the product or service was provided.
Short | HPI FacilityPlace of service or where product was supplied
Control | 0..1
Type | Reference(Location), Address, CodeableConcept
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | false
Requirements | The location can alter whether the item was acceptable for insurance purposes or impact the determination of the benefit amount.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
141. Claim.item.location[x]:locationReference.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.
Short | A 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).
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 10..1
Type | Identifier
Is Modifier | false
Summary | true
Invariants | ele-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}$')`)
143. Claim.item.location[x]:locationReference.identifier.use
Definition | The purpose of this identifier.
Short | The 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.
Control | 0..1
Binding | The codes SHALL be taken from IdentifierUse http://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 .
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
145. Claim.item.location[x]:locationReference.identifier.system
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Short | The system identifier for the organization, facility or nzbnThe namespace for the identifier value
Comments | Identifier.system is always case sensitive.
Control | 10..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
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.
Example | General: http://www.acme.com/identifiers/patient HPI Organisation ID: https://standards.digital.health.nz/ns/hpi-organisation-id
Invariants | ele-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'`)
147. Claim.item.location[x]:locationReference.identifier.value
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Short | The 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.
Control | 10..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Example | General: 123456 Example HPI Org ID: GZZ999-Z
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
149. 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.
Short | Fee, charge or cost per item
Control | 0..01
Type | Money
Is Modifier | false
Summary | false
Requirements | The amount charged to the patient by the provider for a single unit.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
151. Claim.item.net
Definition | The quantity times the unit price for an additional service or product or charge.
Short | Total item cost
Comments | For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.
Control | 0..01
Type | Money
Is Modifier | false
Summary | false
Requirements | Provides the total amount claimed for the group (if a grouper) or the line item.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
153. Claim.total
Definition | The total value of the all the items in the claim.
Short | Total claim cost
Control | 0..01
Type | Money
Is Modifier | false
Summary | false
Requirements | Used for control total purposes.
Invariants | ele-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
Control | 1..?
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
Short | HPI Facility ID from where the record is sourced
Control | 1..?
Invariants | 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
Control | 1..1
8. Claim.meta.tag
Control | 1..?
Slicing | This 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 Name | correlationId
Control | 1..1
12. Claim.meta.tag:correlationId.system
Definition | The system URI used by the hub to identify its correlation ID.
Short | Hub correlation ID system
Control | 1..?
Pattern Value | `https://hub.services.digital.health.nz/ns/correlation-id`
14. Claim.meta.tag:correlationId.code
Control | 1..?
16. Claim.contained
Control | 0..0
18. Claim.extension
Control | 1..?
Slicing | This 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:traceNumber
Slice Name | traceNumber
Control | 0..*
Type | Extension(Shared Care Claim Trace Number) (Extension Type: Identifier)
22. Claim.extension:agreementNumber
Slice Name | agreementNumber
Control | 1..1
Type | Extension(Shared Care Agreement Number) (Extension Type: string)
24. Claim.identifier
Short | Business identifier(s) for the claim
Comments | Business identifier(s) for the claim (external and/or internal identifiers). The system should be the practice/organisation with the PMS (e.g., https://provider-org-name.co.nz/ns/claim-identifier). The value is in the context/namespace of that system, not Health NZ. Integrators should come up with their own system.
Note | This is a business identifier, not a resource identifier (see discussion)
26. Claim.identifier.system
Control | 1..?
28. Claim.identifier.value
Control | 1..?
30. Claim.type
Short | Claim type
Binding | Unless 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` )
32. Claim.subType
Short | Claim subtype
Binding | Unless 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` )
34. Claim.patient
Type | Reference(NZ Patient, Patient)
36. Claim.patient.type
Control | 1..?
Pattern Value | `Patient`
38. Claim.patient.identifier
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 1..?
40. Claim.patient.identifier.system
Control | 1..?
Fixed Value | `https://standards.digital.health.nz/ns/nhi-id`
42. Claim.patient.identifier.value
Short | Must be an absolute URL reference to the patient on the NHI system. See constraints for details.
Control | 1..?
Invariants | 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})$')`)
44. Claim.patient.display
Control | 0..0
46. Claim.billablePeriod
Short | Billing period with datetime including timezone (start is inclusive, end is exclusive)
Comments | The start time is inclusive, end time is exclusive. The end datetime (converted to an inclusive local date) is used as the Claim Date and/or end of the claim period.
Control | 1..?
48. Claim.insurer
Control | 0..0
50. Claim.provider
Short | Legal entity who submitted the claim
Comments | Legal entity who submitted the claim - identifiable by its HPI identifier (or also its NZBN)
Type | Reference(Organization)
52. Claim.provider.identifier
Definition | A local identifier MUST be added to this section to correlate the organization, facility or nzbn.
Short | A local identifier MUST be added to this section.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 1..?
Invariants | 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}$')`)
54. Claim.provider.identifier.use
Short | The local identifier use SHOULD be set to official.
56. Claim.provider.identifier.system
Short | The system identifier for the organization, facility or nzbn
Control | 1..?
Example | HPI Organisation ID: https://standards.digital.health.nz/ns/hpi-organisation-id
Invariants | 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'`)
58. Claim.provider.identifier.value
Short | The actual local identifier value, e.g. GZZ999-Z
Control | 1..?
Example | Example HPI Org ID: GZZ999-Z
60. Claim.fundsReserve
Control | 0..0
62. Claim.prescription
Control | 0..0
64. Claim.originalPrescription
Control | 0..0
66. Claim.payee
Control | 0..0
68. Claim.careTeam
Control | 0..0
70. Claim.supportingInfo
Short | Additional attributes that may accompany a Claim
Comments | Additional attributes that may accompany a Claim including categorisation, coding, date or time, value, and reason.
72. Claim.diagnosis
Control | 0..0
74. Claim.procedure
Control | 0..0
76. Claim.insurance
Control | 0..1
78. Claim.accident
Control | 0..0
80. Claim.item
Short | Each individual product or service being claimed for as part of this claim
82. Claim.item.extension
Slicing | This 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
84. Claim.item.extension:patientPaid
Slice Name | patientPaid
Control | 0..1
Type | Extension(Shared Care Patient Copayment) (Extension Type: Money)
86. Claim.item.sequence
Short | Referred to by the ClaimResponse.item.itemSequence
Must Support | true
88. Claim.item.productOrService
Short | Product or service being claimed (e.g., PU code)
Comments | Use actual PU codes (e.g., COGP0068) and align servicedPeriod with the code for realistic examples
90. Claim.item.serviced[x]
Short | When the claimed event started and ended
Comments | This may determine the applicable fee that should have been charged and possibly the PU code that applies
Type | Period, date
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
92. Claim.item.location[x]
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Slicing | This element introduces a set of slices on `Claim.item.location[x]`. The slices areUnordered and Open, and can be differentiated using the following discriminators: type @ $this
94. Claim.item.location[x]:locationReference
Slice Name | locationReference
Short | HPI Facility
Control | 0..1
Type | Reference(Location)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
96. Claim.item.location[x]:locationReference.identifier
Definition | A local identifier MUST be added to this section to correlate the organization, facility or nzbn.
Short | A local identifier MUST be added to this section.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 1..?
Invariants | 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}$')`)
98. Claim.item.location[x]:locationReference.identifier.use
Short | The local identifier use SHOULD be set to official.
100. Claim.item.location[x]:locationReference.identifier.system
Short | The system identifier for the organization, facility or nzbn
Control | 1..?
Example | HPI Organisation ID: https://standards.digital.health.nz/ns/hpi-organisation-id
Invariants | 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'`)
102. Claim.item.location[x]:locationReference.identifier.value
Short | The actual local identifier value, e.g. GZZ999-Z
Control | 1..?
Example | Example HPI Org ID: GZZ999-Z
104. Claim.item.unitPrice
Control | 0..0
106. Claim.item.net
Control | 0..0
108. Claim.item.detail
110. Claim.item.detail.unitPrice
Control | 0..0
112. Claim.item.detail.net
Control | 0..0
114. Claim.item.detail.subDetail
116. Claim.item.detail.subDetail.unitPrice
Control | 0..0
118. Claim.item.detail.subDetail.net
Control | 0..0
120. Claim.total
Control | 0..0

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.
Short | Claim, 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.
Control | 0..*
Is Modifier | false
Summary | false
Alternate Names | Adjudication Request, Preauthorization Request, Predetermination Request
Invariants | dom-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.
Short | Logical 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.
Control | 0..1
Type | id
Is Modifier | false
Summary | true
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.
Short | Metadata about the resource
Control | 1..1
Type | Meta
Is Modifier | false
Summary | true
Invariants | ele-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.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
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.
Short | Additional 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-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()`)
Slicing | This 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.
Short | Version 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.
Control | 0..1
Type | id
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-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.
Short | When the resource version last changed
Comments | This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.
Control | 0..1
Type | instant
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-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
Short | HPI 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.
Control | 1..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-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.
Short | Profiles 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.
Control | 1..1
Type | canonical(StructureDefinition)
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-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.
Short | Security 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.
Control | 0..*
Binding | Unless 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.
Type | Coding
Is Modifier | false
Summary | true
Invariants | ele-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.
Short | Tags 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.
Control | 1..*
Binding | For 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".
Type | Coding
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
Slicing | This 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 Name | correlationId
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.
Short | Tags 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.
Control | 1..1
Binding | For 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".
Type | Coding
Is Modifier | false
Summary | true
Invariants | ele-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.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
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.
Short | Additional 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-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()`)
Slicing | This 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.
Short | Hub 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.
Control | 1..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Pattern Value | `https://hub.services.digital.health.nz/ns/correlation-id`
Invariants | ele-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.
Short | Version 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.
Note | This is a business version Id, not a resource version Id (see discussion)
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-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).
Short | Symbol in syntax defined by the system
Control | 1..1
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to refer to a particular code in the system.
Invariants | ele-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.
Short | Representation defined by the system
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Invariants | ele-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).
Short | If 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.
Control | 0..1
Type | boolean
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
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.
Invariants | ele-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.
Short | A 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.
Control | 0..1
Type | uri
Is Modifier | true 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 Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-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.
Short | Language 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).
Control | 0..1
Binding | The codes SHOULD be taken from CommonLanguages (preferred to `http://hl7.org/fhir/ValueSet/languages` ) A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-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.
Short | Text 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.
Control | 0..1
Type | Narrative
Is Modifier | false
Summary | false
Alternate Names | narrative, html, xhtml, display
Invariants | ele-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.
Short | Contained, 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.
Control | 0..0
Type | Resource
Is Modifier | false
Summary | false
Alternate Names | inline resources, anonymous resources, contained resources
46. Claim.extension
Definition | An Extension
Short | Extension
Control | 1..*
Type | Extension
Is Modifier | false
Summary | false
Invariants | ele-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()`)
Slicing | This 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:traceNumber
Slice Name | traceNumber
Definition | Internal primary key ID for shared care claim tracking
Short | Shared Care Claim Trace Number
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(Shared Care Claim Trace Number) (Extension Type: Identifier)
Is Modifier | false
Summary | false
Invariants | ele-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:agreementNumber
Slice Name | agreementNumber
Definition | The agreement/contract number between the provider and the 'insurer' (HNZ) including version number
Short | Shared Care Agreement Number
Control | 1..1 This element is affected by the following invariants: ele-1
Type | Extension(Shared Care Agreement Number) (Extension Type: string)
Is Modifier | false
Summary | false
Invariants | ele-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.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).
Short | Extensions 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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summary | false
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 Names | extensions, user content
Invariants | ele-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.identifier
Definition | A unique identifier assigned to this claim.
Short | Business identifier(s) for the claim
Comments | Business identifier(s) for the claim (external and/or internal identifiers). The system should be the practice/organisation with the PMS (e.g., https://provider-org-name.co.nz/ns/claim-identifier). The value is in the context/namespace of that system, not Health NZ. Integrators should come up with their own system.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
Is Modifier | false
Summary | false
Requirements | Allows claims to be distinguished and referenced.
Alternate Names | Claim Number
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
56. 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.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
58. 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.
Short | Additional 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-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()`)
Slicing | This 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
60. Claim.identifier.use
Definition | The purpose of this identifier.
Short | usual | official | temp | secondary | old (If known)
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Control | 0..1
Binding | The 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 .
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
62. Claim.identifier.type
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Short | Description 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.
Control | 0..1
Binding | Unless 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.
Type | CodeableConcept
Is Modifier | false
Summary | true
Requirements | Allows users to make use of identifiers when the identifier system is not known.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
64. Claim.identifier.system
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Short | The namespace for the identifier value
Comments | Identifier.system is always case sensitive.
Control | 1..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
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.
Example | General: http://www.acme.com/identifiers/patient
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
66. Claim.identifier.value
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Short | 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.
Control | 1..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Example | General: 123456
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
68. Claim.identifier.period
Definition | Time period during which identifier is/was valid for use.
Short | Time period when id is/was valid for use
Control | 0..1
Type | Period
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
70. Claim.identifier.assigner
Definition | Organization that issued/manages the identifier.
Short | Organization 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.
Control | 0..1
Type | Reference(Organization)
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
72. Claim.status
Definition | The status of the resource instance.
Short | active | 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.
Control | 1..1
Binding | The 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.
Type | code
Is Modifier | true 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 Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
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'.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
74. Claim.type
Definition | The category of claim, e.g. oral, pharmacy, vision, institutional, professional.
Short | Claim type
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.
Control | 1..1
Binding | Unless 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` )
Type | CodeableConcept
Is Modifier | false
Summary | true
Requirements | Claim type determine the general sets of business rules applied for information requirements and adjudication.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
76. 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.
Short | Claim subtype
Comments | This may contain the local bill type codes, for example the US UB-04 bill type code or the CMS bill type.
Control | 0..1
Binding | Unless 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` )
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Some jurisdictions need a finer grained claim type for routing and adjudication.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
78. 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.
Short | claim | preauthorization | predetermination
Control | 1..1
Binding | The 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.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | This element is required to understand the nature of the request for adjudication.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
80. 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.
Short | The recipient of the products and services
Control | 1..1
Type | Reference(NZ Patient, Patient)
Is Modifier | false
Summary | true
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.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
82. 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.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
84. 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.
Short | Additional 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-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()`)
Slicing | This 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
86. 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.
Short | Literal 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.
Control | 0..1 This element is affected by the following invariants: ref-1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
88. 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).
Short | Type 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.
Control | 1..1
Binding | Unless 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).
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Pattern Value | `Patient`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
90. 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.
Short | 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).
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 1..1
Type | Identifier
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
92. 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.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
94. 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.
Short | Additional 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-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()`)
Slicing | This 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
96. Claim.patient.identifier.use
Definition | The purpose of this identifier.
Short | usual | official | temp | secondary | old (If known)
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Control | 0..1
Binding | The 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 .
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
98. 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.
Short | Description 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.
Control | 0..1
Binding | Unless 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.
Type | CodeableConcept
Is Modifier | false
Summary | true
Requirements | Allows users to make use of identifiers when the identifier system is not known.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
100. Claim.patient.identifier.system
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Short | The namespace for the identifier value
Comments | Identifier.system is always case sensitive.
Control | 1..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Fixed Value | `https://standards.digital.health.nz/ns/nhi-id`
Example | General: http://www.acme.com/identifiers/patient
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
102. 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.
Short | Must 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.
Control | 1..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Example | General: 123456
Invariants | ele-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})$')`)
104. Claim.patient.identifier.period
Definition | Time period during which identifier is/was valid for use.
Short | Time period when id is/was valid for use
Control | 0..1
Type | Period
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
106. Claim.patient.identifier.assigner
Definition | Organization that issued/manages the identifier.
Short | Organization 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.
Control | 0..1
Type | Reference(Organization)
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
108. Claim.patient.display
Definition | Plain text narrative that identifies the resource in addition to the resource reference.
Short | Text 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.
Control | 0..0
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
110. Claim.billablePeriod
Definition | The period for which charges are being submitted.
Short | Billing period with datetime including timezone (start is inclusive, end is exclusive)
Comments | The start time is inclusive, end time is exclusive. The end datetime (converted to an inclusive local date) is used as the Claim Date and/or end of the claim period.
Control | 1..1
Type | Period
Is Modifier | false
Summary | true
Requirements | A number jurisdictions required the submission of the billing period when submitting claims for example for hospital stays or long-term care.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
112. Claim.created
Definition | The date this resource was created.
Short | Resource 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.
Control | 1..1
Type | dateTime
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to record a timestamp for use by both the recipient and the issuer.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
114. Claim.enterer
Definition | Individual who created the claim, predetermination or preauthorization.
Short | Author of the claim
Control | 0..1
Type | Reference(Practitioner, PractitionerRole)
Is Modifier | false
Summary | false
Requirements | Some jurisdictions require the contact information for personnel completing claims.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
116. Claim.insurer
Definition | The Insurer who is target of the request.
Short | Target
Control | 0..0
Type | Reference(Organization)
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
118. Claim.provider
Definition | The provider which is responsible for the claim, predetermination or preauthorization.
Short | Legal entity who submitted the claim
Comments | Legal entity who submitted the claim - identifiable by its HPI identifier (or also its NZBN)
Control | 1..1
Type | Reference(Organization)
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
120. 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.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
122. 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.
Short | Additional 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-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()`)
Slicing | This 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
124. 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.
Short | Literal 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.
Control | 0..1 This element is affected by the following invariants: ref-1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
126. 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).
Short | Type 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.
Control | 0..1
Binding | Unless 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).
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
128. Claim.provider.identifier
Definition | A local identifier MUST be added to this section to correlate the organization, facility or nzbn.
Short | A 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).
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 1..1
Type | Identifier
Is Modifier | false
Summary | true
Invariants | ele-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}$')`)
130. 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.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
132. 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.
Short | Additional 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-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()`)
Slicing | This 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
134. Claim.provider.identifier.use
Definition | The purpose of this identifier.
Short | The 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.
Control | 0..1
Binding | The 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 .
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
136. 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.
Short | Description 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.
Control | 0..1
Binding | Unless 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.
Type | CodeableConcept
Is Modifier | false
Summary | true
Requirements | Allows users to make use of identifiers when the identifier system is not known.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
138. Claim.provider.identifier.system
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Short | The system identifier for the organization, facility or nzbn
Comments | Identifier.system is always case sensitive.
Control | 1..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
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.
Example | General: http://www.acme.com/identifiers/patient HPI Organisation ID: https://standards.digital.health.nz/ns/hpi-organisation-id
Invariants | ele-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'`)
140. 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.
Short | The 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.
Control | 1..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Example | General: 123456 Example HPI Org ID: GZZ999-Z
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
142. Claim.provider.identifier.period
Definition | Time period during which identifier is/was valid for use.
Short | Time period when id is/was valid for use
Control | 0..1
Type | Period
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
144. Claim.provider.identifier.assigner
Definition | Organization that issued/manages the identifier.
Short | Organization 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.
Control | 0..1
Type | Reference(Organization)
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
146. Claim.provider.display
Definition | Plain text narrative that identifies the resource in addition to the resource reference.
Short | Text 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.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
148. Claim.priority
Definition | The provider-required urgency of processing the request. Typical values include: stat, routine deferred.
Short | Desired 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.
Control | 1..1
Binding | For example codes, see ProcessPriorityCodes (example to `http://hl7.org/fhir/ValueSet/process-priority` ) The timeliness with which processing is required: stat, normal, deferred.
Type | CodeableConcept
Is Modifier | false
Summary | true
Requirements | The provider may need to indicate their processing requirements so that the processor can indicate if they are unable to comply.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
150. Claim.fundsReserve
Definition | A code to indicate whether and for whom funds are to be reserved for future claims.
Short | For whom to reserve funds
Comments | This field is only used for preauthorizations.
Control | 0..0
Binding | For example codes, see Funds Reservation Codes (example to `http://hl7.org/fhir/ValueSet/fundsreserve` ) For whom funds are to be reserved: (Patient, Provider, None).
Type | CodeableConcept
Is Modifier | false
Summary | false
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 Names | Fund pre-allocation
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
152. 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.
Short | Prior or corollary claims
Comments | For example, for the original treatment and follow-up exams.
Control | 0..*
Type | BackboneElement
Is Modifier | false
Summary | false
Requirements | For workplace or other accidents it is common to relate separate claims arising from the same event.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
154. 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.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
156. 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.
Short | Additional 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-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()`)
158. 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).
Short | Extensions 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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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 Names | extensions, user content, modifiers
Invariants | ele-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()`)
160. Claim.related.claim
Definition | Reference to a related claim.
Short | Reference to the related claim
Control | 0..1
Type | Reference(Claim)
Is Modifier | false
Summary | false
Requirements | For workplace or other accidents it is common to relate separate claims arising from the same event.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
162. Claim.related.relationship
Definition | A code to convey how the claims are related.
Short | How the reference claim is related
Comments | For example, prior claim or umbrella.
Control | 0..1
Binding | For example codes, see ExampleRelatedClaimRelationshipCodes (example to `http://hl7.org/fhir/ValueSet/related-claim-relationship` ) Relationship of this claim to a related Claim.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Some insurers need a declaration of the type of relationship.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
164. Claim.related.reference
Definition | An alternate organizational reference to the case or file to which this particular claim pertains.
Short | File or case reference
Comments | For example, Property/Casualty insurer claim # or Workers Compensation case # .
Control | 0..1
Type | Identifier
Is Modifier | false
Summary | false
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.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
166. Claim.prescription
Definition | Prescription to support the dispensing of pharmacy, device or vision products.
Short | Prescription authorizing services and products
Control | 0..0
Type | Reference(DeviceRequest, MedicationRequest, VisionPrescription)
Is Modifier | false
Summary | false
Requirements | Required to authorize the dispensing of controlled substances and devices.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
168. Claim.originalPrescription
Definition | Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products.
Short | Original 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'.
Control | 0..0
Type | Reference(DeviceRequest, MedicationRequest, VisionPrescription)
Is Modifier | false
Summary | false
Requirements | Often required when a fulfiller varies what is fulfilled from that authorized on the original prescription.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
170. Claim.payee
Definition | The party to be reimbursed for cost of the products and services according to the terms of the policy.
Short | Recipient 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.
Control | 0..0
Type | BackboneElement
Is Modifier | false
Summary | false
Requirements | The provider needs to specify who they wish to be reimbursed and the claims processor needs express who they will reimburse.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
177. Claim.referral
Definition | A reference to a referral resource.
Short | Treatment referral
Comments | The referral resource which lists the date, practitioner, reason and other supporting information.
Control | 0..1
Type | Reference(ServiceRequest)
Is Modifier | false
Summary | false
Requirements | Some insurers require proof of referral to pay for services or to pay specialist rates for services.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
179. Claim.facility
Definition | Facility where the services were provided.
Short | Servicing facility
Control | 0..1
Type | Reference(Location)
Is Modifier | false
Summary | false
Requirements | Insurance adjudication can be dependant on where services were delivered.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
181. Claim.careTeam
Definition | The members of the team who provided the products and services.
Short | Members of the care team
Control | 0..0
Type | BackboneElement
Is Modifier | false
Summary | false
Requirements | Common to identify the responsible and supporting practitioners.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
191. Claim.supportingInfo
Definition | Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues.
Short | Additional attributes that may accompany a Claim
Comments | Additional attributes that may accompany a Claim including categorisation, coding, date or time, value, and reason.
Control | 0..*
Type | BackboneElement
Is Modifier | false
Summary | false
Requirements | Typically these information codes are required to support the services rendered or the adjudication of the services rendered.
Alternate Names | Attachments Exception Codes Occurrence Codes Value codes
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
193. 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.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
195. 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.
Short | Additional 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-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()`)
197. 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).
Short | Extensions 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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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 Names | extensions, user content, modifiers
Invariants | ele-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()`)
199. Claim.supportingInfo.sequence
Definition | A number to uniquely identify supporting information entries.
Short | Information instance identifier
Control | 1..1
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Necessary to maintain the order of the supporting information items and provide a mechanism to link to claim details.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
201. Claim.supportingInfo.category
Definition | The general class of the information supplied: information; exception; accident, employment; onset, etc.
Short | Classification of the supplied information
Comments | This may contain a category for the local bill type codes.
Control | 1..1
Binding | For example codes, see ClaimInformationCategoryCodes (example to `http://hl7.org/fhir/ValueSet/claim-informationcategory` ) The valuset used for additional information category codes.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Required to group or associate information items with common characteristics. For example: admission information or prior treatments.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
203. 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.
Short | Type of information
Control | 0..1
Binding | For example codes, see ExceptionCodes (example to `http://hl7.org/fhir/ValueSet/claim-exception` ) The valuset used for additional information codes.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Required to identify the kind of additional information.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
205. Claim.supportingInfo.timing[x]
Definition | The date when or period to which this information refers.
Short | When it occurred
Control | 0..1
Type | Choice of: date, Period
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
207. 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.
Short | Data 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.
Control | 0..1
Type | Choice of: boolean, string, Quantity, Attachment, Reference(Resource)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | To convey the data content to be provided when the information is more than a simple code or period.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
209. Claim.supportingInfo.reason
Definition | Provides the reason in the situation where a reason code is required in addition to the content.
Short | Explanation for the information
Comments | For example: the reason for the additional stay, or why a tooth is missing.
Control | 0..1
Binding | For example codes, see MissingToothReasonCodes (example to `http://hl7.org/fhir/ValueSet/missing-tooth-reason` ) Reason codes for the missing teeth.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Needed when the supporting information has both a date and amount/value and requires explanation.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
211. Claim.diagnosis
Definition | Information about diagnoses relevant to the claim items.
Short | Pertinent diagnosis information
Control | 0..0
Type | BackboneElement
Is Modifier | false
Summary | false
Requirements | Required for the adjudication by provided context for the services and product listed.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
221. Claim.procedure
Definition | Procedures performed on the patient relevant to the billing items with the claim.
Short | Clinical procedures performed
Control | 0..0
Type | BackboneElement
Is Modifier | false
Summary | false
Requirements | The specific clinical invention are sometimes required to be provided to justify billing a greater than customary amount for a service.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
231. Claim.insurance
Definition | Financial instruments for reimbursement for the health care products and services specified on the claim.
Short | Patient 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.
Control | 1..1
Type | BackboneElement
Is Modifier | false
Summary | true
Requirements | At least one insurer is required for a claim to be a claim.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
233. 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.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
235. 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.
Short | Additional 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-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()`)
237. 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).
Short | Extensions 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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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 Names | extensions, user content, modifiers
Invariants | ele-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()`)
239. Claim.insurance.sequence
Definition | A number to uniquely identify insurance entries and provide a sequence of coverages to convey coordination of benefit order.
Short | Insurance instance identifier
Control | 1..1
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | To maintain order of the coverages.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
241. Claim.insurance.focal
Definition | A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true.
Short | Coverage 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.
Control | 1..1
Type | boolean
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | To identify which coverage in the list is being used to adjudicate this claim.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
243. Claim.insurance.identifier
Definition | The business identifier to be used when the claim is sent for adjudication against this insurance policy.
Short | Pre-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'.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1
Type | Identifier
Is Modifier | false
Summary | false
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.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
245. 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.
Short | Insurance information
Control | 1..1
Type | Reference(Coverage)
Is Modifier | false
Summary | true
Requirements | Required to allow the adjudicator to locate the correct policy and history within their information system.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
247. Claim.insurance.businessArrangement
Definition | A business agreement number established between the provider and the insurer for special business processing purposes.
Short | Additional provider contract number
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Providers may have multiple business arrangements with a given insurer and must supply the specific contract number for adjudication.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
249. 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.
Short | Prior 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.
Control | 0..*
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Providers must quote previously issued authorization reference numbers in order to obtain adjudication as previously advised on the Preauthorization.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
251. Claim.insurance.claimResponse
Definition | The result of the adjudication of the line items for the Coverage specified in this insurance.
Short | Adjudication results
Comments | Must not be specified when 'focal=true' for this insurance.
Control | 0..1
Type | Reference(ClaimResponse)
Is Modifier | false
Summary | false
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.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
253. Claim.accident
Definition | Details of an accident which resulted in injuries which required the products and services listed in the claim.
Short | Details of the event
Control | 0..0
Type | BackboneElement
Is Modifier | false
Summary | false
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.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
261. 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.
Short | Each individual product or service being claimed for as part of this claim
Control | 0..*
Type | BackboneElement
Is Modifier | false
Summary | false
Requirements | The items to be processed for adjudication.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
263. 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.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
265. Claim.item.extension
Definition | An Extension
Short | Extension
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Invariants | ele-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()`)
Slicing | This 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
267. Claim.item.extension:patientPaid
Slice Name | patientPaid
Definition | Co-payment amount paid by patient for shared care services
Short | Shared Care Patient Copayment
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(Shared Care Patient Copayment) (Extension Type: Money)
Is Modifier | false
Summary | false
Invariants | ele-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()`)
269. 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).
Short | Extensions 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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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 Names | extensions, user content, modifiers
Invariants | ele-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()`)
271. Claim.item.sequence
Definition | A number to uniquely identify item entries.
Short | Referred to by the ClaimResponse.item.itemSequence
Control | 1..1
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | false
Requirements | Necessary to provide a mechanism to link to items from within the claim and within the adjudication details of the ClaimResponse.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
273. Claim.item.careTeamSequence
Definition | CareTeam members related to this service or product.
Short | Applicable careTeam members
Control | 0..*
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Need to identify the individuals and their roles in the provision of the product or service.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
275. Claim.item.diagnosisSequence
Definition | Diagnosis applicable for this service or product.
Short | Applicable diagnoses
Control | 0..*
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Need to related the product or service to the associated diagnoses.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
277. Claim.item.procedureSequence
Definition | Procedures applicable for this service or product.
Short | Applicable procedures
Control | 0..*
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Need to provide any listed specific procedures to support the product or service being claimed.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
279. Claim.item.informationSequence
Definition | Exceptions, special conditions and supporting information applicable for this service or product.
Short | Applicable exception and supporting information
Control | 0..*
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Need to reference the supporting information items that relate directly to this product or service.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
281. Claim.item.revenue
Definition | The type of revenue or cost center providing the product and/or service.
Short | Revenue or cost center code
Control | 0..1
Binding | For 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.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Needed in the processing of institutional claims.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
283. Claim.item.category
Definition | Code to identify the general type of benefits under which products and services are provided.
Short | Benefit classification
Comments | Examples include Medical Care, Periodontics, Renal Dialysis, Vision Coverage.
Control | 0..1
Binding | For example codes, see BenefitCategoryCodes (example to `http://hl7.org/fhir/ValueSet/ex-benefitcategory` ) Benefit categories such as: oral-basic, major, glasses.
Type | CodeableConcept
Is Modifier | false
Summary | false
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.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
285. 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.
Short | Product or service being claimed (e.g., PU code)
Comments | Use actual PU codes (e.g., COGP0068) and align servicedPeriod with the code for realistic examples
Control | 1..1
Binding | For example codes, see USCLSCodes (example to `http://hl7.org/fhir/ValueSet/service-uscls` ) Allowable service and product codes.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Necessary to state what was provided or done.
Alternate Names | Drug Code, Bill Code, Service Code
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
287. Claim.item.modifier
Definition | Item typification or modifiers codes to convey additional context for the product or service.
Short | Product 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.
Control | 0..*
Binding | For 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.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | To support inclusion of the item for adjudication or to charge an elevated fee.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
289. Claim.item.programCode
Definition | Identifies the program under which this may be recovered.
Short | Program the product or service is provided under
Comments | For example: Neonatal program, child dental program or drug users recovery program.
Control | 0..*
Binding | For example codes, see ExampleProgramReasonCodes (example to `http://hl7.org/fhir/ValueSet/ex-program-code` ) Program specific reason codes.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Commonly used in in the identification of publicly provided program focused on population segments or disease classifications.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
291. Claim.item.serviced[x]
Definition | The date or dates when the service or product was supplied, performed or completed.
Short | When the claimed event started and ended
Comments | This may determine the applicable fee that should have been charged and possibly the PU code that applies
Control | 0..1
Type | Period
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | false
Requirements | Needed to determine whether the service or product was provided during the term of the insurance coverage.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
293. Claim.item.location[x]
Definition | Where the product or service was provided.
Short | Place of service or where product was supplied
Control | 0..1
Binding | For example codes, see ExampleServicePlaceCodes (example to `http://hl7.org/fhir/ValueSet/service-place` ) Place of service: pharmacy, school, prison, etc.
Type | Choice of: CodeableConcept, Address, Reference(Location)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | false
Requirements | The location can alter whether the item was acceptable for insurance purposes or impact the determination of the benefit amount.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
Slicing | This element introduces a set of slices on `Claim.item.location[x]`. The slices areUnordered and Open, and can be differentiated using the following discriminators: type @ $this
295. Claim.item.location[x]:locationReference
Slice Name | locationReference
Definition | Where the product or service was provided.
Short | HPI Facility
Control | 0..1
Type | Reference(Location)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | false
Requirements | The location can alter whether the item was acceptable for insurance purposes or impact the determination of the benefit amount.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
297. Claim.item.location[x]:locationReference.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
299. Claim.item.location[x]:locationReference.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.
Short | Additional 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-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()`)
Slicing | This element introduces a set of slices on `Claim.item.location[x].extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
301. Claim.item.location[x]:locationReference.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.
Short | Literal 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.
Control | 0..1 This element is affected by the following invariants: ref-1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
303. Claim.item.location[x]:locationReference.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).
Short | Type 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.
Control | 0..1
Binding | Unless 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).
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
305. Claim.item.location[x]:locationReference.identifier
Definition | A local identifier MUST be added to this section to correlate the organization, facility or nzbn.
Short | A 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).
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 1..1
Type | Identifier
Is Modifier | false
Summary | true
Invariants | ele-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}$')`)
307. Claim.item.location[x]:locationReference.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.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
309. Claim.item.location[x]:locationReference.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.
Short | Additional 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-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()`)
Slicing | This element introduces a set of slices on `Claim.item.location[x].identifier.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
311. Claim.item.location[x]:locationReference.identifier.use
Definition | The purpose of this identifier.
Short | The 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.
Control | 0..1
Binding | The 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 .
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
313. Claim.item.location[x]:locationReference.identifier.type
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Short | Description 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.
Control | 0..1
Binding | Unless 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.
Type | CodeableConcept
Is Modifier | false
Summary | true
Requirements | Allows users to make use of identifiers when the identifier system is not known.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
315. Claim.item.location[x]:locationReference.identifier.system
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Short | The system identifier for the organization, facility or nzbn
Comments | Identifier.system is always case sensitive.
Control | 1..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
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.
Example | General: http://www.acme.com/identifiers/patient HPI Organisation ID: https://standards.digital.health.nz/ns/hpi-organisation-id
Invariants | ele-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'`)
317. Claim.item.location[x]:locationReference.identifier.value
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Short | The 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.
Control | 1..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Example | General: 123456 Example HPI Org ID: GZZ999-Z
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
319. Claim.item.location[x]:locationReference.identifier.period
Definition | Time period during which identifier is/was valid for use.
Short | Time period when id is/was valid for use
Control | 0..1
Type | Period
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
321. Claim.item.location[x]:locationReference.identifier.assigner
Definition | Organization that issued/manages the identifier.
Short | Organization 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.
Control | 0..1
Type | Reference(Organization)
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
323. Claim.item.location[x]:locationReference.display
Definition | Plain text narrative that identifies the resource in addition to the resource reference.
Short | Text 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.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
325. Claim.item.quantity
Definition | The number of repetitions of a service or product.
Short | Count of products or services
Control | 0..1
Type | Quantity(SimpleQuantity)
Is Modifier | false
Summary | false
Requirements | Required when the product or service code does not convey the quantity provided.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
327. 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.
Short | Fee, charge or cost per item
Control | 0..0
Type | Money
Is Modifier | false
Summary | false
Requirements | The amount charged to the patient by the provider for a single unit.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
329. 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.
Short | Price scaling factor
Comments | To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10).
Control | 0..1
Type | decimal
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
331. Claim.item.net
Definition | The quantity times the unit price for an additional service or product or charge.
Short | Total item cost
Comments | For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.
Control | 0..0
Type | Money
Is Modifier | false
Summary | false
Requirements | Provides the total amount claimed for the group (if a grouper) or the line item.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
333. Claim.item.udi
Definition | Unique Device Identifiers associated with this line item.
Short | Unique device identifier
Control | 0..*
Type | Reference(Device)
Is Modifier | false
Summary | false
Requirements | The UDI code allows the insurer to obtain device level information on the product supplied.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
335. Claim.item.bodySite
Definition | Physical service site on the patient (limb, tooth, etc.).
Short | Anatomical 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.
Control | 0..1
Binding | For example codes, see OralSiteCodes (example to `http://hl7.org/fhir/ValueSet/tooth` ) The code for the teeth, quadrant, sextant and arch.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Allows insurer to validate specific procedures.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
337. Claim.item.subSite
Definition | A region or surface of the bodySite, e.g. limb region or tooth surface(s).
Short | Anatomical sub-location
Control | 0..*
Binding | For example codes, see SurfaceCodes (example to `http://hl7.org/fhir/ValueSet/surface` ) The code for the tooth surface and surface combinations.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Allows insurer to validate specific procedures.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
339. Claim.item.encounter
Definition | The Encounters during which this Claim was created or to which the creation of this record is tightly associated.
Short | Encounters 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.
Control | 0..*
Type | Reference(Encounter)
Is Modifier | false
Summary | false
Requirements | Used in some jurisdictions to link clinical events to claim items.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
341. 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.
Short | Product or service provided
Control | 0..*
Type | BackboneElement
Is Modifier | false
Summary | false
Requirements | The items to be processed for adjudication.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
343. 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.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
345. Claim.item.detail.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.
Short | Additional 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-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()`)
347. 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).
Short | Extensions 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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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 Names | extensions, user content, modifiers
Invariants | ele-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()`)
349. Claim.item.detail.sequence
Definition | A number to uniquely identify item entries.
Short | Item instance identifier
Control | 1..1
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Necessary to provide a mechanism to link to items from within the claim and within the adjudication details of the ClaimResponse.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
351. Claim.item.detail.revenue
Definition | The type of revenue or cost center providing the product and/or service.
Short | Revenue or cost center code
Control | 0..1
Binding | For 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.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Needed in the processing of institutional claims.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
353. Claim.item.detail.category
Definition | Code to identify the general type of benefits under which products and services are provided.
Short | Benefit classification
Comments | Examples include Medical Care, Periodontics, Renal Dialysis, Vision Coverage.
Control | 0..1
Binding | For example codes, see BenefitCategoryCodes (example to `http://hl7.org/fhir/ValueSet/ex-benefitcategory` ) Benefit categories such as: oral-basic, major, glasses.
Type | CodeableConcept
Is Modifier | false
Summary | false
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.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
355. 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.
Short | Billing, 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'.
Control | 1..1
Binding | For example codes, see USCLSCodes (example to `http://hl7.org/fhir/ValueSet/service-uscls` ) Allowable service and product codes.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Necessary to state what was provided or done.
Alternate Names | Drug Code, Bill Code, Service Code
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
357. Claim.item.detail.modifier
Definition | Item typification or modifiers codes to convey additional context for the product or service.
Short | Service/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.
Control | 0..*
Binding | For 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.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | To support inclusion of the item for adjudication or to charge an elevated fee.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
359. Claim.item.detail.programCode
Definition | Identifies the program under which this may be recovered.
Short | Program the product or service is provided under
Comments | For example: Neonatal program, child dental program or drug users recovery program.
Control | 0..*
Binding | For example codes, see ExampleProgramReasonCodes (example to `http://hl7.org/fhir/ValueSet/ex-program-code` ) Program specific reason codes.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Commonly used in in the identification of publicly provided program focused on population segments or disease classifications.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
361. Claim.item.detail.quantity
Definition | The number of repetitions of a service or product.
Short | Count of products or services
Control | 0..1
Type | Quantity(SimpleQuantity)
Is Modifier | false
Summary | false
Requirements | Required when the product or service code does not convey the quantity provided.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
363. 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.
Short | Fee, charge or cost per item
Control | 0..0
Type | Money
Is Modifier | false
Summary | false
Requirements | The amount charged to the patient by the provider for a single unit.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
365. 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.
Short | Price scaling factor
Comments | To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10).
Control | 0..1
Type | decimal
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
367. Claim.item.detail.net
Definition | The quantity times the unit price for an additional service or product or charge.
Short | Total item cost
Comments | For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.
Control | 0..0
Type | Money
Is Modifier | false
Summary | false
Requirements | Provides the total amount claimed for the group (if a grouper) or the line item.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
369. Claim.item.detail.udi
Definition | Unique Device Identifiers associated with this line item.
Short | Unique device identifier
Control | 0..*
Type | Reference(Device)
Is Modifier | false
Summary | false
Requirements | The UDI code allows the insurer to obtain device level information on the product supplied.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
371. 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.
Short | Product or service provided
Control | 0..*
Type | BackboneElement
Is Modifier | false
Summary | false
Requirements | The items to be processed for adjudication.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
373. 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.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
375. 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.
Short | Additional 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-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()`)
377. 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).
Short | Extensions 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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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 Names | extensions, user content, modifiers
Invariants | ele-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()`)
379. Claim.item.detail.subDetail.sequence
Definition | A number to uniquely identify item entries.
Short | Item instance identifier
Control | 1..1
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Necessary to provide a mechanism to link to items from within the claim and within the adjudication details of the ClaimResponse.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
381. Claim.item.detail.subDetail.revenue
Definition | The type of revenue or cost center providing the product and/or service.
Short | Revenue or cost center code
Control | 0..1
Binding | For 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.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Needed in the processing of institutional claims.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
383. Claim.item.detail.subDetail.category
Definition | Code to identify the general type of benefits under which products and services are provided.
Short | Benefit classification
Comments | Examples include Medical Care, Periodontics, Renal Dialysis, Vision Coverage.
Control | 0..1
Binding | For example codes, see BenefitCategoryCodes (example to `http://hl7.org/fhir/ValueSet/ex-benefitcategory` ) Benefit categories such as: oral-basic, major, glasses.
Type | CodeableConcept
Is Modifier | false
Summary | false
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.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
385. 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.
Short | Billing, 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'.
Control | 1..1
Binding | For example codes, see USCLSCodes (example to `http://hl7.org/fhir/ValueSet/service-uscls` ) Allowable service and product codes.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Necessary to state what was provided or done.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
387. Claim.item.detail.subDetail.modifier
Definition | Item typification or modifiers codes to convey additional context for the product or service.
Short | Service/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.
Control | 0..*
Binding | For 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.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | To support inclusion of the item for adjudication or to charge an elevated fee.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
389. Claim.item.detail.subDetail.programCode
Definition | Identifies the program under which this may be recovered.
Short | Program the product or service is provided under
Comments | For example: Neonatal program, child dental program or drug users recovery program.
Control | 0..*
Binding | For example codes, see ExampleProgramReasonCodes (example to `http://hl7.org/fhir/ValueSet/ex-program-code` ) Program specific reason codes.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Commonly used in in the identification of publicly provided program focused on population segments or disease classifications.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
391. Claim.item.detail.subDetail.quantity
Definition | The number of repetitions of a service or product.
Short | Count of products or services
Control | 0..1
Type | Quantity(SimpleQuantity)
Is Modifier | false
Summary | false
Requirements | Required when the product or service code does not convey the quantity provided.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
393. 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.
Short | Fee, charge or cost per item
Control | 0..0
Type | Money
Is Modifier | false
Summary | false
Requirements | The amount charged to the patient by the provider for a single unit.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
395. 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.
Short | Price scaling factor
Comments | To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10).
Control | 0..1
Type | decimal
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
397. Claim.item.detail.subDetail.net
Definition | The quantity times the unit price for an additional service or product or charge.
Short | Total item cost
Comments | For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.
Control | 0..0
Type | Money
Is Modifier | false
Summary | false
Requirements | Provides the total amount claimed for the group (if a grouper) or the line item.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
399. Claim.item.detail.subDetail.udi
Definition | Unique Device Identifiers associated with this line item.
Short | Unique device identifier
Control | 0..*
Type | Reference(Device)
Is Modifier | false
Summary | false
Requirements | The UDI code allows the insurer to obtain device level information on the product supplied.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
401. Claim.total
Definition | The total value of the all the items in the claim.
Short | Total claim cost
Control | 0..0
Type | Money
Is Modifier | false
Summary | false
Requirements | Used for control total purposes.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)