Skip to main content


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

A provider issued list of services and products provided, or to be provided, to a patient which is provided to an insurer for payment recovery.

Property Inventory


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


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

Details about an accident.

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

Period for charge submission.

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

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");

Creation date.

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

List of Diagnosis.

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

Period unable to work.

Property methods: employmentImpactedGet(), employmentImpactedGetSwizzled(), employmentImpactedIsValid(), employmentImpactedNewObject(), employmentImpactedSet()
property enterer as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "enterer", XMLPROJECTION = "ELEMENT");



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

Servicing Facility.


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

Funds requested to be reserved.

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

Property methods: fundsReserveGet(), fundsReserveGetSwizzled(), fundsReserveIsValid(), fundsReserveNewObject(), fundsReserveSet()
property hospitalization as HS.FHIR.DTL.vSTU3.Model.Datatype.Period (XMLNAME = "hospitalization", XMLPROJECTION = "ELEMENT");

Period in hospital.

Property methods: hospitalizationGet(), hospitalizationGetSwizzled(), hospitalizationIsValid(), hospitalizationNewObject(), hospitalizationSet()
property identifier as list of HS.FHIR.DTL.vSTU3.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");

Claim number.

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

Exceptions, special considerations, the condition, situation, prior or concurrent issues.

Property methods: informationBuildValueArray(), informationCollectionToDisplay(), informationCollectionToOdbc(), informationDisplayToCollection(), informationGet(), informationGetObject(), informationGetObjectId(), informationGetSwizzled(), informationIsValid(), informationOdbcToCollection(), informationSet(), informationSetObject(), informationSetObjectId()
property insurance as list of (XMLNAME = "insurance", XMLPROJECTION = "ELEMENT");

Insurance or medical plan.

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



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

Goods and Services.

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

Responsible organization.


Property methods: organizationGet(), organizationGetSwizzled(), organizationIsValid(), organizationNewObject(), organizationSet()
property originalPrescription as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "originalPrescription", XMLPROJECTION = "ELEMENT");

Original prescription if superceded by fulfiller.


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

The subject of the Products and Services.


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

Party to be paid any benefits payable.

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

Prescription authorizing services or products.

MedicationRequest | VisionPrescription

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

Desired processing priority.

any FHIR3 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.vSTU3.Model.Element.Claim.procedure (XMLNAME = "procedure", XMLPROJECTION = "ELEMENT");

Procedures performed.

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

Responsible provider.


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

Treatment Referral.


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

Related Claims which may be revelant to processing this claimn.

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");

active | cancelled | draft | entered-in-error

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

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

Finer grained claim type information.

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

Property methods: subTypeBuildValueArray(), subTypeCollectionToDisplay(), subTypeCollectionToOdbc(), subTypeDisplayToCollection(), subTypeGet(), subTypeGetObject(), subTypeGetObjectId(), subTypeGetSwizzled(), subTypeIsValid(), subTypeOdbcToCollection(), subTypeSet(), subTypeSetObject(), subTypeSetObjectId()
property total as HS.FHIR.DTL.vSTU3.Model.Datatype.Money (XMLNAME = "total", XMLPROJECTION = "ELEMENT");

Total claim cost.

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

Type or discipline.

claim-type is the REQUIRED FHIR3 ValueSet for codes; you may NOT extend claim-type and you may NOT use codes from other ValueSets.

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

complete | proposed | exploratory | other

claim-use is the REQUIRED FHIR3 ValueSet for codes; you may NOT extend claim-use 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