Private OptionalidentifierClaim.identifier Element
Private OptionaltraceClaim.traceNumber Element
FHIR Specification
IdentifierPrivate ReadonlyfmFHIR CodeSystem: FmStatus
PrivatestatusClaim.status Element
FHIR Specification
codeCodeSystem Enumeration: FmStatusEnum
Privatetype_Claim.type Element
FHIR Specification
CodeableConceptPrivate OptionalsubClaim.subType Element
FHIR Specification
CodeableConceptPrivate ReadonlyclaimFHIR CodeSystem: ClaimUse
PrivateuseClaim.use Element
FHIR Specification
codeCodeSystem Enumeration: ClaimUseEnum
PrivatepatientClaim.patient Element
FHIR Specification
Reference
Private OptionalbillableClaim.billablePeriod Element
FHIR Specification
PeriodPrivatecreatedClaim.created Element
FHIR Specification
dateTimePrivate OptionalentererClaim.enterer Element
FHIR Specification
Reference
Private OptionalinsurerClaim.insurer Element
FHIR Specification
Reference
Private OptionalproviderClaim.provider Element
FHIR Specification
Reference
Private OptionalpriorityClaim.priority Element
FHIR Specification
CodeableConceptPrivate OptionalfundsClaim.fundsReserve Element
FHIR Specification
CodeableConceptPrivate OptionalrelatedClaim.related Element
FHIR Specification
BackboneElementPrivate OptionalprescriptionClaim.prescription Element
FHIR Specification
Reference
Private OptionaloriginalClaim.originalPrescription Element
FHIR Specification
Reference
Private OptionalpayeeClaim.payee Element
FHIR Specification
BackboneElementPrivate OptionalreferralClaim.referral Element
FHIR Specification
Reference
Private OptionalencounterClaim.encounter Element
FHIR Specification
Reference
Private OptionalfacilityClaim.facility Element
FHIR Specification
Reference
Private OptionaldiagnosisClaim.diagnosisRelatedGroup Element
FHIR Specification
CodeableConceptPrivate OptionaleventClaim.event Element
Private OptionalcareClaim.careTeam Element
Private OptionalsupportingClaim.supportingInfo Element
FHIR Specification
BackboneElementPrivate OptionaldiagnosisClaim.diagnosis Element
FHIR Specification
BackboneElementPrivate OptionalprocedureClaim.procedure Element
FHIR Specification
BackboneElementPrivate OptionalinsuranceClaim.insurance Element
FHIR Specification
BackboneElementPrivate OptionalaccidentClaim.accident Element
FHIR Specification
BackboneElementPrivate OptionalpatientClaim.patientPaid Element
FHIR Specification
MoneyPrivate OptionalitemClaim.item Element
FHIR Specification
BackboneElementPrivate OptionaltotalClaim.total Element
StaticparseParse the provided Claim JSON to instantiate the Claim data model.
JSON representing FHIR Claim
OptionaloptSourceField: stringOptional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to Claim
Claim data model or undefined for Claim
JsonError if the provided JSON is not a valid JSON object
the identifier property value as a Identifier array
Assigns the provided Identifier array value to the identifier property.
the identifier array value
this
InvalidTypeError for invalid data types
Add the provided Identifier value to the identifier array property.
the identifier value
this
InvalidTypeError for invalid data types
true if the identifier property exists and has a value; false otherwise
the traceNumber property value as a Identifier array
Assigns the provided Identifier array value to the traceNumber property.
the traceNumber array value
this
InvalidTypeError for invalid data types
Add the provided Identifier value to the traceNumber array property.
the traceNumber value
this
InvalidTypeError for invalid data types
true if the traceNumber property exists and has a value; false otherwise
the status property value as a EnumCodeType if defined; else null
CodeSystem Enumeration: FmStatusEnum
Assigns the provided EnumCodeType value to the status property.
the status value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: FmStatusEnum
true if the status property exists and has a value; false otherwise
the status property value as a CodeType if defined; else null
CodeSystem Enumeration: FmStatusEnum
Assigns the provided PrimitiveType value to the status property.
the status value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: FmStatusEnum
true if the status property exists and has a value; false otherwise
the status property value as a fhirCode if defined; else null
CodeSystem Enumeration: FmStatusEnum
Assigns the provided primitive value to the status property.
the status value
this
InvalidCodeError for invalid code value
PrimitiveTypeError for invalid primitive types
CodeSystem Enumeration: FmStatusEnum
true if the status property exists and has a value; false otherwise
the type_ property value as a CodeableConcept object if defined; else an empty CodeableConcept object
Assigns the provided CodeableConcept object value to the type_ property.
the type_ object value
this
InvalidTypeError for invalid data types
true if the type_ property exists and has a value; false otherwise
the subType property value as a CodeableConcept object if defined; else an empty CodeableConcept object
Assigns the provided SubType object value to the subType property.
the subType object value
this
InvalidTypeError for invalid data types
true if the subType property exists and has a value; false otherwise
the use property value as a EnumCodeType if defined; else null
CodeSystem Enumeration: ClaimUseEnum
Assigns the provided EnumCodeType value to the use property.
the use value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: ClaimUseEnum
true if the use property exists and has a value; false otherwise
the use property value as a CodeType if defined; else null
CodeSystem Enumeration: ClaimUseEnum
Assigns the provided PrimitiveType value to the use property.
the use value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: ClaimUseEnum
true if the use property exists and has a value; false otherwise
the use property value as a fhirCode if defined; else null
CodeSystem Enumeration: ClaimUseEnum
Assigns the provided primitive value to the use property.
the use value
this
InvalidCodeError for invalid code value
PrimitiveTypeError for invalid primitive types
CodeSystem Enumeration: ClaimUseEnum
true if the use property exists and has a value; false otherwise
the patient property value as a Reference object if defined; else an empty Reference object
Assigns the provided Patient object value to the patient property.
the patient object value
this
InvalidTypeError for invalid data type or reference value
true if the patient property exists and has a value; false otherwise
the billablePeriod property value as a Period object if defined; else an empty Period object
Assigns the provided BillablePeriod object value to the billablePeriod property.
the billablePeriod object value
this
InvalidTypeError for invalid data types
true if the billablePeriod property exists and has a value; false otherwise
the created property value as a DateTimeType object if defined; else an empty DateTimeType object
Assigns the provided PrimitiveType value to the created property.
the created value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the created property exists and has a value; false otherwise
the created property value as a fhirDateTime if defined; else null
Assigns the provided primitive value to the created property.
the created value
this
PrimitiveTypeError for invalid primitive types
true if the created property exists and has a value; false otherwise
the enterer property value as a Reference object; else an empty Reference object
Assigns the provided Enterer object value to the enterer property.
the enterer object value
this
@ReferenceTargets('Claim.enterer', ['Practitioner','PractitionerRole','Patient','RelatedPerson',])
InvalidTypeError for invalid data type or reference value
true if the enterer property exists and has a value; false otherwise
the insurer property value as a Reference object; else an empty Reference object
Assigns the provided Insurer object value to the insurer property.
the insurer object value
this
InvalidTypeError for invalid data type or reference value
true if the insurer property exists and has a value; false otherwise
the provider property value as a Reference object; else an empty Reference object
Assigns the provided Provider object value to the provider property.
the provider object value
this
InvalidTypeError for invalid data type or reference value
true if the provider property exists and has a value; false otherwise
the priority property value as a CodeableConcept object if defined; else an empty CodeableConcept object
Assigns the provided Priority object value to the priority property.
the priority object value
this
InvalidTypeError for invalid data types
true if the priority property exists and has a value; false otherwise
the fundsReserve property value as a CodeableConcept object if defined; else an empty CodeableConcept object
Assigns the provided FundsReserve object value to the fundsReserve property.
the fundsReserve object value
this
InvalidTypeError for invalid data types
true if the fundsReserve property exists and has a value; false otherwise
the related property value as a ClaimRelatedComponent array
Assigns the provided ClaimRelatedComponent array value to the related property.
the related array value
this
InvalidTypeError for invalid data types
Add the provided ClaimRelatedComponent value to the related array property.
the related value
this
InvalidTypeError for invalid data types
true if the related property exists and has a value; false otherwise
the prescription property value as a Reference object; else an empty Reference object
Assigns the provided Prescription object value to the prescription property.
the prescription object value
this
@ReferenceTargets('Claim.prescription', ['DeviceRequest','MedicationRequest','VisionPrescription',])
InvalidTypeError for invalid data type or reference value
true if the prescription property exists and has a value; false otherwise
the originalPrescription property value as a Reference object; else an empty Reference object
Assigns the provided OriginalPrescription object value to the originalPrescription property.
the originalPrescription object value
this
@ReferenceTargets('Claim.originalPrescription', ['DeviceRequest','MedicationRequest','VisionPrescription',])
InvalidTypeError for invalid data type or reference value
true if the originalPrescription property exists and has a value; false otherwise
the payee property value as a ClaimPayeeComponent object if defined; else an empty ClaimPayeeComponent object
Assigns the provided Payee object value to the payee property.
the payee object value
this
InvalidTypeError for invalid data types
true if the payee property exists and has a value; false otherwise
the referral property value as a Reference object; else an empty Reference object
Assigns the provided Referral object value to the referral property.
the referral object value
this
InvalidTypeError for invalid data type or reference value
true if the referral property exists and has a value; false otherwise
the encounter property value as a Reference array
Assigns the provided Reference array value to the encounter property.
the encounter array value
this
InvalidTypeError for invalid data type or reference value
Add the provided Reference value to the encounter array property.
the encounter value
this
InvalidTypeError for invalid data type or reference value
true if the encounter property exists and has a value; false otherwise
the facility property value as a Reference object; else an empty Reference object
Assigns the provided Facility object value to the facility property.
the facility object value
this
InvalidTypeError for invalid data type or reference value
true if the facility property exists and has a value; false otherwise
the diagnosisRelatedGroup property value as a CodeableConcept object if defined; else an empty CodeableConcept object
Assigns the provided DiagnosisRelatedGroup object value to the diagnosisRelatedGroup property.
the diagnosisRelatedGroup object value
this
InvalidTypeError for invalid data types
true if the diagnosisRelatedGroup property exists and has a value; false otherwise
the event property value as a ClaimEventComponent array
Assigns the provided ClaimEventComponent array value to the event property.
the event array value
this
InvalidTypeError for invalid data types
Add the provided ClaimEventComponent value to the event array property.
the event value
this
InvalidTypeError for invalid data types
true if the event property exists and has a value; false otherwise
the careTeam property value as a ClaimCareTeamComponent array
Assigns the provided ClaimCareTeamComponent array value to the careTeam property.
the careTeam array value
this
InvalidTypeError for invalid data types
Add the provided ClaimCareTeamComponent value to the careTeam array property.
the careTeam value
this
InvalidTypeError for invalid data types
true if the careTeam property exists and has a value; false otherwise
the supportingInfo property value as a ClaimSupportingInfoComponent array
Assigns the provided ClaimSupportingInfoComponent array value to the supportingInfo property.
the supportingInfo array value
this
InvalidTypeError for invalid data types
Add the provided ClaimSupportingInfoComponent value to the supportingInfo array property.
the supportingInfo value
this
InvalidTypeError for invalid data types
true if the supportingInfo property exists and has a value; false otherwise
the diagnosis property value as a ClaimDiagnosisComponent array
Assigns the provided ClaimDiagnosisComponent array value to the diagnosis property.
the diagnosis array value
this
InvalidTypeError for invalid data types
Add the provided ClaimDiagnosisComponent value to the diagnosis array property.
the diagnosis value
this
InvalidTypeError for invalid data types
true if the diagnosis property exists and has a value; false otherwise
the procedure property value as a ClaimProcedureComponent array
Assigns the provided ClaimProcedureComponent array value to the procedure property.
the procedure array value
this
InvalidTypeError for invalid data types
Add the provided ClaimProcedureComponent value to the procedure array property.
the procedure value
this
InvalidTypeError for invalid data types
true if the procedure property exists and has a value; false otherwise
the insurance property value as a ClaimInsuranceComponent array
Assigns the provided ClaimInsuranceComponent array value to the insurance property.
the insurance array value
this
InvalidTypeError for invalid data types
Add the provided ClaimInsuranceComponent value to the insurance array property.
the insurance value
this
InvalidTypeError for invalid data types
true if the insurance property exists and has a value; false otherwise
the accident property value as a ClaimAccidentComponent object if defined; else an empty ClaimAccidentComponent object
Assigns the provided Accident object value to the accident property.
the accident object value
this
InvalidTypeError for invalid data types
true if the accident property exists and has a value; false otherwise
the patientPaid property value as a Money object if defined; else an empty Money object
Assigns the provided PatientPaid object value to the patientPaid property.
the patientPaid object value
this
InvalidTypeError for invalid data types
true if the patientPaid property exists and has a value; false otherwise
the item property value as a ClaimItemComponent array
Assigns the provided ClaimItemComponent array value to the item property.
the item array value
this
InvalidTypeError for invalid data types
Add the provided ClaimItemComponent value to the item array property.
the item value
this
InvalidTypeError for invalid data types
true if the item property exists and has a value; false otherwise
the total property value as a Money object if defined; else an empty Money object
Assigns the provided Total object value to the total property.
the total object value
this
InvalidTypeError for invalid data types
true if the total property exists and has a value; false otherwise
the FHIR type defined in the FHIR standard
true if the instance is empty; false otherwise
true if and only if the data model has required fields (min cardinality > 0)
and at least one of those required fields in the instance is empty; false otherwise
Creates a copy of the current instance.
the a new instance copied from the current instance
the JSON value or undefined if the instance is empty
the text property value as a Narrative
Assigns the provided value to the text property.
the text value
this
true if the text property exists and has a value; false otherwise
the contained property value as a Resource array
Assigns the provided Resource array value to the contained property.
the contained array value
this
Add the provided Resource value to the contained array property.
the contained value
this
true if the contained property exists and has a value; false otherwise
the array of extension values
Assigns the provided array of Extension values to the extension property.
array of Extensions
this
Determines if the extension property exists.
Optionalurl: stringthe url that identifies a specific Extension
true if an Extension has the provided url; false otherwise
If the url is provided, determines if an Extension having
the provided url exists. If the url is not provided, determines
if the extension property exists and has any values.
AssertionError for invalid url
Returns the Extension having the provided url.
the url that identifies a specific Extension
the Extension having the provided url
AssertionError for invalid url
Adds the provided Extension to the extension property array.
the Extension value to add to the extension property array
this
Removes the Extension having the provided url from the extension property array.
the url that identifies a specific Extension to remove
AssertionError for invalid url
the array of modifierExtension values
Assigns the provided array of Extension values to the modifierExtension property.
array of Extensions
this
Determines if the modifierExtension property exists.
Optionalurl: stringthe url that identifies a specific Extension
true if an Extension has the provided url
If the url is provided, determines if an Extension having
the provided url exists. If the url is not provided, determines
if the modifierExtension property exists and has any values.
AssertionError for invalid url
Returns the Extension having the provided url.
the url that identifies a specific Extension
the Extension having the provided url
AssertionError for invalid url
Adds the provided Extension to the modifierExtension property array.
the Extension value to add to the modifierExtension property array
this
Removes the Extension having the provided url from the modifierExtension property array.
the url that identifies a specific Extension to remove
AssertionError for invalid url
the FHIR resource type as defined by the FHIR specification
the id property value as a PrimitiveType
Assigns the provided PrimitiveType value to the id property.
the id value
this
true if the id property exists and has a value; false otherwise
the id property value as a primitive value
Assigns the provided primitive value to the id property.
the id value
this
PrimitiveTypeError for invalid primitive types
true if the id property exists and has a value; false otherwise
the meta property value as a Meta
Assigns the provided value to the meta property.
the meta value
this
true if the meta property exists and has a value; false otherwise
the implicitRules property value as a PrimitiveType
Assigns the provided PrimitiveType value to the implicitRules property.
the implicitRules value
this
true if the implicitRules property exists and has a value; false otherwise
the implicitRules property value as a primitive value
Assigns the provided primitive value to the implicitRules property.
the implicitRules value
this
PrimitiveTypeError for invalid primitive types
true if the system property exists and has a value; false otherwise
the language property value as a PrimitiveType
Assigns the provided PrimitiveType value to the language property.
the language value
this
true if the language property exists and has a value; false otherwise
the language property value as a primitive value
Assigns the provided primitive value to the language property.
the language value
this
PrimitiveTypeError for invalid primitive types
true if the language property exists and has a value; false otherwise
true if the instance is a FHIR resource; false otherwise
true if the instance is a FHIR complex or primitive datatype; false otherwise
true if the instance is a FHIR complex datatype; false otherwise
true if the instance is a FHIR primitive datatype; false otherwise
true if the instance is a FHIR primitive boolean datatype; false otherwise
true if the instance is a FHIR primitive string-based datatype; false otherwise
true if the instance is a FHIR primitive number-based datatype; false otherwise
true if the instance is a FHIR primitive bigint-based datatype; false otherwise
true if the instance is a FHIR primitive datetime-based datatype; false otherwise
ProtectedcopyProtectedCopies the current instance's elements into the provided object.
the copied instance
PrivateinitInitialize the identifier property
PrivateinitInitialize the traceNumber property
PrivateinitInitialize the related property
PrivateinitInitialize the encounter property
PrivateinitInitialize the event property
PrivateinitInitialize the careTeam property
PrivateinitInitialize the supportingInfo property
PrivateinitInitialize the diagnosis property
PrivateinitInitialize the procedure property
PrivateinitInitialize the insurance property
PrivateinitInitialize the item property
Claim Class
Remarks
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.
The Claim resource is used by providers to exchange services and products rendered to patients or planned to be rendered with insurers for reimbuserment. It is also used by insurers to exchange claims information with statutory reporting and data analytics firms.
FHIR Specification
See
FHIR Claim