Skip to main content

HS.FHIR.DTL.vR4.Model.Resource.Claim

class HS.FHIR.DTL.vR4.Model.Resource.Claim extends HS.FHIR.DTL.vR4.Model.Base.DomainResource

Claim, Pre-determination or Pre-authorization.

Property Inventory

Parameters

parameter ELEMENTQUALIFIED = 1;
Inherited description: ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute. NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.
parameter XMLNAME = Claim;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.
parameter XMLPROJECTION = ELEMENT;
parameter XMLSEQUENCE = 1;
Inherited description: If the XMLSEQUENCE = 1, then the order of the XML elements must match the order of the class properties. This allows us to deal with XML where the same field appears multiple times and is distinguished by the order.
parameter XMLTYPE = Claim;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is empty then the class name will be used to construct a default XML type. The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.

Properties

property accident as HS.FHIR.DTL.vR4.Model.Element.Claim.accident (XMLNAME = "accident", XMLPROJECTION = "ELEMENT");
BackboneElement

Details of the event.

Property methods: accidentGet(), accidentGetSwizzled(), accidentIsValid(), accidentNewObject(), accidentSet()
property billablePeriod as HS.FHIR.DTL.vR4.Model.Datatype.Period (XMLNAME = "billablePeriod", XMLPROJECTION = "ELEMENT");
Period

Relevant time frame for the claim.

Property methods: billablePeriodGet(), billablePeriodGetSwizzled(), billablePeriodIsValid(), billablePeriodNewObject(), billablePeriodSet()
property careTeam as list of HS.FHIR.DTL.vR4.Model.Element.Claim.careTeam (XMLNAME = "careTeam", XMLPROJECTION = "ELEMENT");
BackboneElement

Members of the care team.

Property methods: careTeamBuildValueArray(), careTeamCollectionToDisplay(), careTeamCollectionToOdbc(), careTeamDisplayToCollection(), careTeamGet(), careTeamGetObject(), careTeamGetObjectId(), careTeamGetSwizzled(), careTeamIsValid(), careTeamOdbcToCollection(), careTeamSet(), careTeamSetObject(), careTeamSetObjectId()
property created as %String (MAXLEN = 1000000, XMLNAME = "created", XMLPROJECTION = "ATTRIBUTE") [ Required ];
dateTime

Resource creation date.

Property methods: createdDisplayToLogical(), createdGet(), createdIsValid(), createdLogicalToDisplay(), createdLogicalToOdbc(), createdNormalize(), createdSet()
property diagnosis as list of HS.FHIR.DTL.vR4.Model.Element.Claim.diagnosis (XMLNAME = "diagnosis", XMLPROJECTION = "ELEMENT");
BackboneElement

Pertinent diagnosis information.

Property methods: diagnosisBuildValueArray(), diagnosisCollectionToDisplay(), diagnosisCollectionToOdbc(), diagnosisDisplayToCollection(), diagnosisGet(), diagnosisGetObject(), diagnosisGetObjectId(), diagnosisGetSwizzled(), diagnosisIsValid(), diagnosisOdbcToCollection(), diagnosisSet(), diagnosisSetObject(), diagnosisSetObjectId()
property enterer as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "enterer", XMLPROJECTION = "ELEMENT");
Reference

Author of the claim.

Practitioner | PractitionerRole

Property methods: entererGet(), entererGetSwizzled(), entererIsValid(), entererNewObject(), entererSet()
property facility as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "facility", XMLPROJECTION = "ELEMENT");
Reference

Servicing facility.

Location

Property methods: facilityGet(), facilityGetSwizzled(), facilityIsValid(), facilityNewObject(), facilitySet()
property fundsReserve as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "fundsReserve", XMLPROJECTION = "ELEMENT");
CodeableConcept

For whom to reserve funds.

any FHIR4 code may be used; fundsreserve shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: fundsReserveGet(), fundsReserveGetSwizzled(), fundsReserveIsValid(), fundsReserveNewObject(), fundsReserveSet()
property identifier as list of HS.FHIR.DTL.vR4.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
Identifier

Business Identifier for claim.

Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property insurance as list of HS.FHIR.DTL.vR4.Model.Element.Claim.insurance (XMLNAME = "insurance", XMLPROJECTION = "ELEMENT") [ Required ];
BackboneElement

Patient insurance information.

Property methods: insuranceBuildValueArray(), insuranceCollectionToDisplay(), insuranceCollectionToOdbc(), insuranceDisplayToCollection(), insuranceGet(), insuranceGetObject(), insuranceGetObjectId(), insuranceGetSwizzled(), insuranceIsValid(), insuranceOdbcToCollection(), insuranceSet(), insuranceSetObject(), insuranceSetObjectId()
property insurer as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "insurer", XMLPROJECTION = "ELEMENT");
Reference

Target.

Organization

Property methods: insurerGet(), insurerGetSwizzled(), insurerIsValid(), insurerNewObject(), insurerSet()
property item as list of HS.FHIR.DTL.vR4.Model.Element.Claim.item (XMLNAME = "item", XMLPROJECTION = "ELEMENT");
BackboneElement

Product or service provided.

Property methods: itemBuildValueArray(), itemCollectionToDisplay(), itemCollectionToOdbc(), itemDisplayToCollection(), itemGet(), itemGetObject(), itemGetObjectId(), itemGetSwizzled(), itemIsValid(), itemOdbcToCollection(), itemSet(), itemSetObject(), itemSetObjectId()
property originalPrescription as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "originalPrescription", XMLPROJECTION = "ELEMENT");
Reference

Original prescription if superseded by fulfiller.

DeviceRequest | MedicationRequest | VisionPrescription

Property methods: originalPrescriptionGet(), originalPrescriptionGetSwizzled(), originalPrescriptionIsValid(), originalPrescriptionNewObject(), originalPrescriptionSet()
property patient as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "patient", XMLPROJECTION = "ELEMENT") [ Required ];
Reference

The recipient of the products and services.

Patient

Property methods: patientGet(), patientGetSwizzled(), patientIsValid(), patientNewObject(), patientSet()
property payee as HS.FHIR.DTL.vR4.Model.Element.Claim.payee (XMLNAME = "payee", XMLPROJECTION = "ELEMENT");
BackboneElement

Recipient of benefits payable.

Property methods: payeeGet(), payeeGetSwizzled(), payeeIsValid(), payeeNewObject(), payeeSet()
property prescription as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "prescription", XMLPROJECTION = "ELEMENT");
Reference

Prescription authorizing services and products.

DeviceRequest | MedicationRequest | VisionPrescription

Property methods: prescriptionGet(), prescriptionGetSwizzled(), prescriptionIsValid(), prescriptionNewObject(), prescriptionSet()
property priority as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "priority", XMLPROJECTION = "ELEMENT") [ Required ];
CodeableConcept

Desired processing ugency.

any FHIR4 code may be used; process-priority shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: priorityGet(), priorityGetSwizzled(), priorityIsValid(), priorityNewObject(), prioritySet()
property procedure as list of HS.FHIR.DTL.vR4.Model.Element.Claim.procedure (XMLNAME = "procedure", XMLPROJECTION = "ELEMENT");
BackboneElement

Clinical procedures performed.

Property methods: procedureBuildValueArray(), procedureCollectionToDisplay(), procedureCollectionToOdbc(), procedureDisplayToCollection(), procedureGet(), procedureGetObject(), procedureGetObjectId(), procedureGetSwizzled(), procedureIsValid(), procedureOdbcToCollection(), procedureSet(), procedureSetObject(), procedureSetObjectId()
property provider as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "provider", XMLPROJECTION = "ELEMENT") [ Required ];
Reference

Party responsible for the claim.

Practitioner | PractitionerRole | Organization

Property methods: providerGet(), providerGetSwizzled(), providerIsValid(), providerNewObject(), providerSet()
property referral as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "referral", XMLPROJECTION = "ELEMENT");
Reference

Treatment referral.

ServiceRequest

Property methods: referralGet(), referralGetSwizzled(), referralIsValid(), referralNewObject(), referralSet()
BackboneElement

Prior or corollary claims.

Property methods: relatedBuildValueArray(), relatedCollectionToDisplay(), relatedCollectionToOdbc(), relatedDisplayToCollection(), relatedGet(), relatedGetObject(), relatedGetObjectId(), relatedGetSwizzled(), relatedIsValid(), relatedOdbcToCollection(), relatedSet(), relatedSetObject(), relatedSetObjectId()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

active | cancelled | draft | entered-in-error

fm-status|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend fm-status|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property subType as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "subType", XMLPROJECTION = "ELEMENT");
CodeableConcept

More granular claim type.

any FHIR4 code may be used; claim-subtype shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: subTypeGet(), subTypeGetSwizzled(), subTypeIsValid(), subTypeNewObject(), subTypeSet()
property supportingInfo as list of HS.FHIR.DTL.vR4.Model.Element.Claim.supportingInfo (XMLNAME = "supportingInfo", XMLPROJECTION = "ELEMENT");
BackboneElement

Supporting information.

Property methods: supportingInfoBuildValueArray(), supportingInfoCollectionToDisplay(), supportingInfoCollectionToOdbc(), supportingInfoDisplayToCollection(), supportingInfoGet(), supportingInfoGetObject(), supportingInfoGetObjectId(), supportingInfoGetSwizzled(), supportingInfoIsValid(), supportingInfoOdbcToCollection(), supportingInfoSet(), supportingInfoSetObject(), supportingInfoSetObjectId()
property total as HS.FHIR.DTL.vR4.Model.Datatype.Money (XMLNAME = "total", XMLPROJECTION = "ELEMENT");
Money

Total claim cost.

Property methods: totalGet(), totalGetSwizzled(), totalIsValid(), totalNewObject(), totalSet()
property type as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "type", XMLPROJECTION = "ELEMENT") [ Required ];
CodeableConcept

Category or discipline.

claim-type is the REQUIRED FHIR4 ValueSet for codes, but if you need to express meanings not found in claim-type, you may formally EXTEND claim-type to add codes to it.

Property methods: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()
property use as %String (MAXLEN = 1000000, XMLNAME = "use", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

claim | preauthorization | predetermination

claim-use|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend claim-use|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: useDisplayToLogical(), useGet(), useIsValid(), useLogicalToDisplay(), useLogicalToOdbc(), useNormalize(), useSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab