Class Claim
- All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement
,Serializable
,org.hl7.fhir.instance.model.api.IAnyResource
,org.hl7.fhir.instance.model.api.IBase
,org.hl7.fhir.instance.model.api.IBaseHasExtensions
,org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions
,org.hl7.fhir.instance.model.api.IBaseResource
,org.hl7.fhir.instance.model.api.IDomainResource
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
static class
static class
static class
static class
static class
static class
static class
static class
static class
static class
static class
static class
Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base
Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason
-
Field Summary
Modifier and TypeFieldDescriptionprotected Claim.AccidentComponent
Details of an accident which resulted in injuries which required the products and services listed in the claim.protected Period
The period for which charges are being submitted.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for care-teamprotected List
<Claim.CareTeamComponent> The members of the team who provided the products and services.protected DateTimeType
The date this resource was created.static final ca.uhn.fhir.rest.gclient.DateClientParam
Fluent Client search parameter constant for createdstatic final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for detail-udiprotected List
<Claim.DiagnosisComponent> Information about diagnoses relevant to the claim items.protected CodeableConcept
A package billing code or bundle code used to group products and services to a particular health condition (such as heart attack) which is based on a predetermined grouping code system.Healthcare encounters related to this claim.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for encounterprotected Reference
Individual who created the claim, predetermination or preauthorization.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for entererprotected List
<Claim.ClaimEventComponent> Information code for an event with a corresponding date or period.protected Reference
Facility where the services were provided.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for facilityprotected CodeableConcept
A code to indicate whether and for whom funds are to be reserved for future claims.protected List
<Identifier> A unique identifier assigned to this claim.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for identifierstatic final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.protected List
<Claim.InsuranceComponent> Financial instruments for reimbursement for the health care products and services specified on the claim.protected Reference
The Insurer who is target of the request.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for insurerprotected List
<Claim.ItemComponent> A claim line.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for item-udiprotected Reference
Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products.protected Reference
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.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for patientprotected Money
The amount paid by the patient, in total at the claim claim level or specifically for the item and detail level, to the provider for goods and services.protected Claim.PayeeComponent
The party to be reimbursed for cost of the products and services according to the terms of the policy.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for payeeprotected Reference
Prescription is the document/authorization given to the claim author for them to provide products and services for which consideration (reimbursement) is sought.protected CodeableConcept
The provider-required urgency of processing the request.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for priorityprotected List
<Claim.ProcedureComponent> Procedures performed on the patient relevant to the billing items with the claim.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for procedure-udiprotected Reference
The provider which is responsible for the claim, predetermination or preauthorization.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for providerprotected Reference
The referral information received by the claim author, it is not to be used when the author generates a referral for a patient.protected List
<Claim.RelatedClaimComponent> Other claims which are related to this claim such as prior submissions or claims for related services or for the same event.static final String
Search parameter: care-teamstatic final String
Search parameter: createdstatic final String
Search parameter: detail-udistatic final String
Search parameter: encounterstatic final String
Search parameter: entererstatic final String
Search parameter: facilitystatic final String
Search parameter: identifierstatic final String
Search parameter: insurerstatic final String
Search parameter: item-udistatic final String
Search parameter: patientstatic final String
Search parameter: payeestatic final String
Search parameter: prioritystatic final String
Search parameter: procedure-udistatic final String
Search parameter: providerstatic final String
Search parameter: statusstatic final String
Search parameter: subdetail-udistatic final String
Search parameter: useThe status of the resource instance.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for statusstatic final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for subdetail-udiprotected CodeableConcept
A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.protected List
<Claim.SupportingInformationComponent> Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues.protected Money
The total value of the all the items in the claim.protected List
<Identifier> Trace number for tracking purposes.protected CodeableConcept
The category of claim, e.g.protected Enumeration
<Enumerations.Use> A code to indicate whether the nature of the request is: Claim - A request to an Insurer to adjudicate the supplied charges for health care goods and services under the identified policy and to pay the determined Benefit amount, if any; Preauthorization - A request to an Insurer to adjudicate the supplied proposed future charges for health care goods and services under the identified policy and to approve the services and provide the expected benefit amounts and potentially to reserve funds to pay the benefits when Claims for the indicated services are later submitted; or, Pre-determination - A request to an Insurer to adjudicate the supplied 'what if' charges for health care goods and services under the identified policy and report back what the Benefit payable would be had the services actually been provided.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for useFields inherited from class org.hl7.fhir.r5.model.DomainResource
contained, extension, modifierExtension, SP_TEXT, text, TEXT
Fields inherited from class org.hl7.fhir.r5.model.Resource
id, implicitRules, language, meta
Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAG
Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET
-
Constructor Summary
ConstructorDescriptionClaim()
ConstructorClaim
(Enumerations.FinancialResourceStatusCodes status, CodeableConcept type, Enumerations.Use use, Reference patient, Date created) Constructor -
Method Summary
Modifier and TypeMethodDescriptionaddEvent()
addItem()
copy()
void
copyValues
(Claim dst) boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
getEvent()
getItem()
getNamedProperty
(int _hash, String _name, boolean _checkValid) getPayee()
Base[]
getProperty
(int hash, String name, boolean checkValid) getTotal()
getType()
String[]
getTypesForProperty
(int hash, String name) getUse()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasEvent()
boolean
boolean
boolean
boolean
boolean
boolean
hasItem()
boolean
boolean
boolean
boolean
hasPayee()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasTotal()
boolean
boolean
hasType()
boolean
hasUse()
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) void
removeChild
(String name, Base value) setBillablePeriod
(Period value) setCareTeam
(List<Claim.CareTeamComponent> theCareTeam) setCreated
(Date value) setCreatedElement
(DateTimeType value) setDiagnosis
(List<Claim.DiagnosisComponent> theDiagnosis) setEncounter
(List<Reference> theEncounter) setEnterer
(Reference value) setEvent
(List<Claim.ClaimEventComponent> theEvent) setFacility
(Reference value) setFundsReserve
(CodeableConcept value) setIdentifier
(List<Identifier> theIdentifier) setInsurance
(List<Claim.InsuranceComponent> theInsurance) setInsurer
(Reference value) setItem
(List<Claim.ItemComponent> theItem) setOriginalPrescription
(Reference value) setPatient
(Reference value) setPatientPaid
(Money value) setPayee
(Claim.PayeeComponent value) setPrescription
(Reference value) setPriority
(CodeableConcept value) setProcedure
(List<Claim.ProcedureComponent> theProcedure) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setProvider
(Reference value) setReferral
(Reference value) setRelated
(List<Claim.RelatedClaimComponent> theRelated) setSubType
(CodeableConcept value) setSupportingInfo
(List<Claim.SupportingInformationComponent> theSupportingInfo) setTraceNumber
(List<Identifier> theTraceNumber) setType
(CodeableConcept value) setUse
(Enumerations.Use value) setUseElement
(Enumeration<Enumerations.Use> value) protected Claim
Methods inherited from class org.hl7.fhir.r5.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getStandardsStatus, getText, hasContained, hasExtension, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setStandardsStatus, setText
Methods inherited from class org.hl7.fhir.r5.model.Resource
copyValues, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, getSourcePackage, getWebPath, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, hasSourcePackage, hasWebPath, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta, setSourcePackage, setWebPath
Methods inherited from class org.hl7.fhir.r5.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
Methods inherited from class org.hl7.fhir.r5.model.Base
addDefinition, addFormatCommentsPost, addFormatCommentsPre, addValidationMessage, canHavePrimitiveValue, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyFormatComments, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getValidationMessages, getXhtml, hasFormatComment, hasFormatCommentPost, hasFormatCommentPre, hasPrimitiveValue, hasType, hasUserData, hasValidated, hasValidationInfo, hasValidationMessages, isBooleanPrimitive, isCopyUserData, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setCopyUserData, setUserData, setUserDataINN
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData
Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, isDeleted, setId
-
Field Details
-
identifier
A unique identifier assigned to this claim. -
traceNumber
Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners. -
status
The status of the resource instance. -
type
The category of claim, e.g. oral, pharmacy, vision, institutional, professional. -
subType
A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service. -
use
A code to indicate whether the nature of the request is: Claim - A request to an Insurer to adjudicate the supplied charges for health care goods and services under the identified policy and to pay the determined Benefit amount, if any; Preauthorization - A request to an Insurer to adjudicate the supplied proposed future charges for health care goods and services under the identified policy and to approve the services and provide the expected benefit amounts and potentially to reserve funds to pay the benefits when Claims for the indicated services are later submitted; or, Pre-determination - A request to an Insurer to adjudicate the supplied 'what if' charges for health care goods and services under the identified policy and report back what the Benefit payable would be had the services actually been provided. -
patient
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. -
billablePeriod
The period for which charges are being submitted. -
created
The date this resource was created. -
enterer
Individual who created the claim, predetermination or preauthorization. -
insurer
The Insurer who is target of the request. -
provider
The provider which is responsible for the claim, predetermination or preauthorization. -
priority
The provider-required urgency of processing the request. Typical values include: stat, normal, deferred. -
fundsReserve
A code to indicate whether and for whom funds are to be reserved for future claims. -
prescription
Prescription is the document/authorization given to the claim author for them to provide products and services for which consideration (reimbursement) is sought. Could be a RX for medications, an 'order' for oxygen or wheelchair or physiotherapy treatments. -
originalPrescription
Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products. -
payee
The party to be reimbursed for cost of the products and services according to the terms of the policy. -
referral
The referral information received by the claim author, it is not to be used when the author generates a referral for a patient. A copy of that referral may be provided as supporting information. Some insurers require proof of referral to pay for services or to pay specialist rates for services. -
encounter
Healthcare encounters related to this claim. -
facility
Facility where the services were provided. -
diagnosisRelatedGroup
A package billing code or bundle code used to group products and services to a particular health condition (such as heart attack) which is based on a predetermined grouping code system. -
event
Information code for an event with a corresponding date or period. -
careTeam
The members of the team who provided the products and services. -
supportingInfo
Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues. -
diagnosis
Information about diagnoses relevant to the claim items. -
procedure
Procedures performed on the patient relevant to the billing items with the claim. -
insurance
Financial instruments for reimbursement for the health care products and services specified on the claim. -
accident
Details of an accident which resulted in injuries which required the products and services listed in the claim. -
patientPaid
The amount paid by the patient, in total at the claim claim level or specifically for the item and detail level, to the provider for goods and services. -
item
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. -
total
The total value of the all the items in the claim. -
SP_CARE_TEAM
Search parameter: care-teamDescription: Member of the CareTeam
Type: reference
Path: Claim.careTeam.provider
- See Also:
-
CARE_TEAM
Fluent Client search parameter constant for care-teamDescription: Member of the CareTeam
Type: reference
Path: Claim.careTeam.provider
-
INCLUDE_CARE_TEAM
Constant for fluent queries to be used to add include statements. Specifies the path value of "Claim:care-team". -
SP_CREATED
Search parameter: createdDescription: The creation date for the Claim
Type: date
Path: Claim.created
- See Also:
-
CREATED
Fluent Client search parameter constant for createdDescription: The creation date for the Claim
Type: date
Path: Claim.created
-
SP_DETAIL_UDI
Search parameter: detail-udiDescription: UDI associated with a line item, detail product or service
Type: reference
Path: Claim.item.detail.udi
- See Also:
-
DETAIL_UDI
Fluent Client search parameter constant for detail-udiDescription: UDI associated with a line item, detail product or service
Type: reference
Path: Claim.item.detail.udi
-
INCLUDE_DETAIL_UDI
Constant for fluent queries to be used to add include statements. Specifies the path value of "Claim:detail-udi". -
SP_ENTERER
Search parameter: entererDescription: The party responsible for the entry of the Claim
Type: reference
Path: Claim.enterer
- See Also:
-
ENTERER
Fluent Client search parameter constant for entererDescription: The party responsible for the entry of the Claim
Type: reference
Path: Claim.enterer
-
INCLUDE_ENTERER
Constant for fluent queries to be used to add include statements. Specifies the path value of "Claim:enterer". -
SP_FACILITY
Search parameter: facilityDescription: Facility where the products or services have been or will be provided
Type: reference
Path: Claim.facility
- See Also:
-
FACILITY
Fluent Client search parameter constant for facilityDescription: Facility where the products or services have been or will be provided
Type: reference
Path: Claim.facility
-
INCLUDE_FACILITY
Constant for fluent queries to be used to add include statements. Specifies the path value of "Claim:facility". -
SP_INSURER
Search parameter: insurerDescription: The target payor/insurer for the Claim
Type: reference
Path: Claim.insurer
- See Also:
-
INSURER
Fluent Client search parameter constant for insurerDescription: The target payor/insurer for the Claim
Type: reference
Path: Claim.insurer
-
INCLUDE_INSURER
Constant for fluent queries to be used to add include statements. Specifies the path value of "Claim:insurer". -
SP_ITEM_UDI
Search parameter: item-udiDescription: UDI associated with a line item product or service
Type: reference
Path: Claim.item.udi
- See Also:
-
ITEM_UDI
Fluent Client search parameter constant for item-udiDescription: UDI associated with a line item product or service
Type: reference
Path: Claim.item.udi
-
INCLUDE_ITEM_UDI
Constant for fluent queries to be used to add include statements. Specifies the path value of "Claim:item-udi". -
SP_PAYEE
Search parameter: payeeDescription: The party receiving any payment for the Claim
Type: reference
Path: Claim.payee.party
- See Also:
-
PAYEE
Fluent Client search parameter constant for payeeDescription: The party receiving any payment for the Claim
Type: reference
Path: Claim.payee.party
-
INCLUDE_PAYEE
Constant for fluent queries to be used to add include statements. Specifies the path value of "Claim:payee". -
SP_PRIORITY
Search parameter: priorityDescription: Processing priority requested
Type: token
Path: Claim.priority
- See Also:
-
PRIORITY
Fluent Client search parameter constant for priorityDescription: Processing priority requested
Type: token
Path: Claim.priority
-
SP_PROCEDURE_UDI
Search parameter: procedure-udiDescription: UDI associated with a procedure
Type: reference
Path: Claim.procedure.udi
- See Also:
-
PROCEDURE_UDI
Fluent Client search parameter constant for procedure-udiDescription: UDI associated with a procedure
Type: reference
Path: Claim.procedure.udi
-
INCLUDE_PROCEDURE_UDI
Constant for fluent queries to be used to add include statements. Specifies the path value of "Claim:procedure-udi". -
SP_PROVIDER
Search parameter: providerDescription: Provider responsible for the Claim
Type: reference
Path: Claim.provider
- See Also:
-
PROVIDER
Fluent Client search parameter constant for providerDescription: Provider responsible for the Claim
Type: reference
Path: Claim.provider
-
INCLUDE_PROVIDER
Constant for fluent queries to be used to add include statements. Specifies the path value of "Claim:provider". -
SP_STATUS
Search parameter: statusDescription: The status of the Claim instance.
Type: token
Path: Claim.status
- See Also:
-
STATUS
Fluent Client search parameter constant for statusDescription: The status of the Claim instance.
Type: token
Path: Claim.status
-
SP_SUBDETAIL_UDI
Search parameter: subdetail-udiDescription: UDI associated with a line item, detail, subdetail product or service
Type: reference
Path: Claim.item.detail.subDetail.udi
- See Also:
-
SUBDETAIL_UDI
Fluent Client search parameter constant for subdetail-udiDescription: UDI associated with a line item, detail, subdetail product or service
Type: reference
Path: Claim.item.detail.subDetail.udi
-
INCLUDE_SUBDETAIL_UDI
Constant for fluent queries to be used to add include statements. Specifies the path value of "Claim:subdetail-udi". -
SP_USE
Search parameter: useDescription: The kind of financial resource
Type: token
Path: Claim.use
- See Also:
-
USE
Fluent Client search parameter constant for useDescription: The kind of financial resource
Type: token
Path: Claim.use
-
SP_ENCOUNTER
Search parameter: encounterDescription: Multiple Resources: [AuditEvent](auditevent.html): Encounter related to the activity recorded in the AuditEvent [CarePlan](careplan.html): The Encounter during which this CarePlan was created [ChargeItem](chargeitem.html): Encounter associated with event [Claim](claim.html): Encounters associated with a billed line item [ClinicalImpression](clinicalimpression.html): The Encounter during which this ClinicalImpression was created [Communication](communication.html): The Encounter during which this Communication was created [CommunicationRequest](communicationrequest.html): The Encounter during which this CommunicationRequest was created [Composition](composition.html): Context of the Composition [Condition](condition.html): The Encounter during which this Condition was created [DeviceRequest](devicerequest.html): Encounter during which request was created [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made [EncounterHistory](encounterhistory.html): The Encounter associated with this set of history values [ExplanationOfBenefit](explanationofbenefit.html): Encounters associated with a billed line item [Flag](flag.html): Alert relevant during encounter [ImagingStudy](imagingstudy.html): The context of the study [List](list.html): Context in which list created [MedicationDispense](medicationdispense.html): Returns dispenses with a specific encounter [MedicationStatement](medicationstatement.html): Returns statements for a specific encounter [NutritionIntake](nutritionintake.html): Returns statements for a specific encounter [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier [Observation](observation.html): Encounter related to the observation [Procedure](procedure.html): The Encounter during which this Procedure was created [Provenance](provenance.html): Encounter related to the Provenance [QuestionnaireResponse](questionnaireresponse.html): Encounter associated with the questionnaire response [RequestOrchestration](requestorchestration.html): The encounter the request orchestration applies to [RiskAssessment](riskassessment.html): Where was assessment performed? [ServiceRequest](servicerequest.html): An encounter in which this request is made [Task](task.html): Search by encounter [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier
Type: reference
Path: AuditEvent.encounter | CarePlan.encounter | ChargeItem.encounter | Claim.item.encounter | ClinicalImpression.encounter | Communication.encounter | CommunicationRequest.encounter | Composition.encounter | Condition.encounter | DeviceRequest.encounter | DiagnosticReport.encounter | EncounterHistory.encounter | ExplanationOfBenefit.item.encounter | Flag.encounter | ImagingStudy.encounter | List.encounter | MedicationDispense.encounter | MedicationStatement.encounter | NutritionIntake.encounter | NutritionOrder.encounter | Observation.encounter | Procedure.encounter | Provenance.encounter | QuestionnaireResponse.encounter | RequestOrchestration.encounter | RiskAssessment.encounter | ServiceRequest.encounter | Task.encounter | VisionPrescription.encounter
- See Also:
-
ENCOUNTER
Fluent Client search parameter constant for encounterDescription: Multiple Resources: [AuditEvent](auditevent.html): Encounter related to the activity recorded in the AuditEvent [CarePlan](careplan.html): The Encounter during which this CarePlan was created [ChargeItem](chargeitem.html): Encounter associated with event [Claim](claim.html): Encounters associated with a billed line item [ClinicalImpression](clinicalimpression.html): The Encounter during which this ClinicalImpression was created [Communication](communication.html): The Encounter during which this Communication was created [CommunicationRequest](communicationrequest.html): The Encounter during which this CommunicationRequest was created [Composition](composition.html): Context of the Composition [Condition](condition.html): The Encounter during which this Condition was created [DeviceRequest](devicerequest.html): Encounter during which request was created [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made [EncounterHistory](encounterhistory.html): The Encounter associated with this set of history values [ExplanationOfBenefit](explanationofbenefit.html): Encounters associated with a billed line item [Flag](flag.html): Alert relevant during encounter [ImagingStudy](imagingstudy.html): The context of the study [List](list.html): Context in which list created [MedicationDispense](medicationdispense.html): Returns dispenses with a specific encounter [MedicationStatement](medicationstatement.html): Returns statements for a specific encounter [NutritionIntake](nutritionintake.html): Returns statements for a specific encounter [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier [Observation](observation.html): Encounter related to the observation [Procedure](procedure.html): The Encounter during which this Procedure was created [Provenance](provenance.html): Encounter related to the Provenance [QuestionnaireResponse](questionnaireresponse.html): Encounter associated with the questionnaire response [RequestOrchestration](requestorchestration.html): The encounter the request orchestration applies to [RiskAssessment](riskassessment.html): Where was assessment performed? [ServiceRequest](servicerequest.html): An encounter in which this request is made [Task](task.html): Search by encounter [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier
Type: reference
Path: AuditEvent.encounter | CarePlan.encounter | ChargeItem.encounter | Claim.item.encounter | ClinicalImpression.encounter | Communication.encounter | CommunicationRequest.encounter | Composition.encounter | Condition.encounter | DeviceRequest.encounter | DiagnosticReport.encounter | EncounterHistory.encounter | ExplanationOfBenefit.item.encounter | Flag.encounter | ImagingStudy.encounter | List.encounter | MedicationDispense.encounter | MedicationStatement.encounter | NutritionIntake.encounter | NutritionOrder.encounter | Observation.encounter | Procedure.encounter | Provenance.encounter | QuestionnaireResponse.encounter | RequestOrchestration.encounter | RiskAssessment.encounter | ServiceRequest.encounter | Task.encounter | VisionPrescription.encounter
-
INCLUDE_ENCOUNTER
Constant for fluent queries to be used to add include statements. Specifies the path value of "Claim:encounter". -
SP_IDENTIFIER
Search parameter: identifierDescription: Multiple Resources: [Account](account.html): Account number [AdverseEvent](adverseevent.html): Business identifier for the event [AllergyIntolerance](allergyintolerance.html): External ids for this item [Appointment](appointment.html): An Identifier of the Appointment [AppointmentResponse](appointmentresponse.html): An Identifier in this appointment response [Basic](basic.html): Business identifier [BodyStructure](bodystructure.html): Bodystructure identifier [CarePlan](careplan.html): External Ids for this plan [CareTeam](careteam.html): External Ids for this team [ChargeItem](chargeitem.html): Business Identifier for item [Claim](claim.html): The primary identifier of the financial resource [ClaimResponse](claimresponse.html): The identity of the ClaimResponse [ClinicalImpression](clinicalimpression.html): Business identifier [Communication](communication.html): Unique identifier [CommunicationRequest](communicationrequest.html): Unique identifier [Composition](composition.html): Version-independent identifier for the Composition [Condition](condition.html): A unique identifier of the condition record [Consent](consent.html): Identifier for this record (external references) [Contract](contract.html): The identity of the contract [Coverage](coverage.html): The primary identifier of the insured and the coverage [CoverageEligibilityRequest](coverageeligibilityrequest.html): The business identifier of the Eligibility [CoverageEligibilityResponse](coverageeligibilityresponse.html): The business identifier [DetectedIssue](detectedissue.html): Unique id for the detected issue [DeviceRequest](devicerequest.html): Business identifier for request/order [DeviceUsage](deviceusage.html): Search by identifier [DiagnosticReport](diagnosticreport.html): An identifier for the report [DocumentReference](documentreference.html): Identifier of the attachment binary [Encounter](encounter.html): Identifier(s) by which this encounter is known [EnrollmentRequest](enrollmentrequest.html): The business identifier of the Enrollment [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare [ExplanationOfBenefit](explanationofbenefit.html): The business identifier of the Explanation of Benefit [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier [Flag](flag.html): Business identifier [Goal](goal.html): External Ids for this goal [GuidanceResponse](guidanceresponse.html): The identifier of the guidance response [ImagingSelection](imagingselection.html): Identifiers for the imaging selection [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID [Immunization](immunization.html): Business identifier [ImmunizationEvaluation](immunizationevaluation.html): ID of the evaluation [ImmunizationRecommendation](immunizationrecommendation.html): Business identifier [Invoice](invoice.html): Business Identifier for item [List](list.html): Business identifier [MeasureReport](measurereport.html): External identifier of the measure report to be returned [Medication](medication.html): Returns medications with this external identifier [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier [MedicationStatement](medicationstatement.html): Return statements with this external identifier [MolecularSequence](molecularsequence.html): The unique identity for a particular sequence [NutritionIntake](nutritionintake.html): Return statements with this external identifier [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier [Observation](observation.html): The unique id for a particular observation [Person](person.html): A person Identifier [Procedure](procedure.html): A unique identifier for a procedure [QuestionnaireResponse](questionnaireresponse.html): The unique identifier for the questionnaire response [RelatedPerson](relatedperson.html): An Identifier of the RelatedPerson [RequestOrchestration](requestorchestration.html): External identifiers for the request orchestration [ResearchSubject](researchsubject.html): Business Identifier for research subject in a study [RiskAssessment](riskassessment.html): Unique identifier for the assessment [ServiceRequest](servicerequest.html): Identifiers assigned to this order [Specimen](specimen.html): The unique identifier associated with the specimen [SupplyDelivery](supplydelivery.html): External identifier [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest [Task](task.html): Search for a task instance by its business identifier [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier
Type: token
Path: Account.identifier | AdverseEvent.identifier | AllergyIntolerance.identifier | Appointment.identifier | AppointmentResponse.identifier | Basic.identifier | BodyStructure.identifier | CarePlan.identifier | CareTeam.identifier | ChargeItem.identifier | Claim.identifier | ClaimResponse.identifier | ClinicalImpression.identifier | Communication.identifier | CommunicationRequest.identifier | Composition.identifier | Condition.identifier | Consent.identifier | Contract.identifier | Coverage.identifier | CoverageEligibilityRequest.identifier | CoverageEligibilityResponse.identifier | DetectedIssue.identifier | DeviceRequest.identifier | DeviceUsage.identifier | DiagnosticReport.identifier | DocumentReference.identifier | Encounter.identifier | EnrollmentRequest.identifier | EpisodeOfCare.identifier | ExplanationOfBenefit.identifier | FamilyMemberHistory.identifier | Flag.identifier | Goal.identifier | GuidanceResponse.identifier | ImagingSelection.identifier | ImagingStudy.identifier | Immunization.identifier | ImmunizationEvaluation.identifier | ImmunizationRecommendation.identifier | Invoice.identifier | List.identifier | MeasureReport.identifier | Medication.identifier | MedicationAdministration.identifier | MedicationDispense.identifier | MedicationRequest.identifier | MedicationStatement.identifier | MolecularSequence.identifier | NutritionIntake.identifier | NutritionOrder.identifier | Observation.identifier | Person.identifier | Procedure.identifier | QuestionnaireResponse.identifier | RelatedPerson.identifier | RequestOrchestration.identifier | ResearchSubject.identifier | RiskAssessment.identifier | ServiceRequest.identifier | Specimen.identifier | SupplyDelivery.identifier | SupplyRequest.identifier | Task.identifier | VisionPrescription.identifier
- See Also:
-
IDENTIFIER
Fluent Client search parameter constant for identifierDescription: Multiple Resources: [Account](account.html): Account number [AdverseEvent](adverseevent.html): Business identifier for the event [AllergyIntolerance](allergyintolerance.html): External ids for this item [Appointment](appointment.html): An Identifier of the Appointment [AppointmentResponse](appointmentresponse.html): An Identifier in this appointment response [Basic](basic.html): Business identifier [BodyStructure](bodystructure.html): Bodystructure identifier [CarePlan](careplan.html): External Ids for this plan [CareTeam](careteam.html): External Ids for this team [ChargeItem](chargeitem.html): Business Identifier for item [Claim](claim.html): The primary identifier of the financial resource [ClaimResponse](claimresponse.html): The identity of the ClaimResponse [ClinicalImpression](clinicalimpression.html): Business identifier [Communication](communication.html): Unique identifier [CommunicationRequest](communicationrequest.html): Unique identifier [Composition](composition.html): Version-independent identifier for the Composition [Condition](condition.html): A unique identifier of the condition record [Consent](consent.html): Identifier for this record (external references) [Contract](contract.html): The identity of the contract [Coverage](coverage.html): The primary identifier of the insured and the coverage [CoverageEligibilityRequest](coverageeligibilityrequest.html): The business identifier of the Eligibility [CoverageEligibilityResponse](coverageeligibilityresponse.html): The business identifier [DetectedIssue](detectedissue.html): Unique id for the detected issue [DeviceRequest](devicerequest.html): Business identifier for request/order [DeviceUsage](deviceusage.html): Search by identifier [DiagnosticReport](diagnosticreport.html): An identifier for the report [DocumentReference](documentreference.html): Identifier of the attachment binary [Encounter](encounter.html): Identifier(s) by which this encounter is known [EnrollmentRequest](enrollmentrequest.html): The business identifier of the Enrollment [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare [ExplanationOfBenefit](explanationofbenefit.html): The business identifier of the Explanation of Benefit [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier [Flag](flag.html): Business identifier [Goal](goal.html): External Ids for this goal [GuidanceResponse](guidanceresponse.html): The identifier of the guidance response [ImagingSelection](imagingselection.html): Identifiers for the imaging selection [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID [Immunization](immunization.html): Business identifier [ImmunizationEvaluation](immunizationevaluation.html): ID of the evaluation [ImmunizationRecommendation](immunizationrecommendation.html): Business identifier [Invoice](invoice.html): Business Identifier for item [List](list.html): Business identifier [MeasureReport](measurereport.html): External identifier of the measure report to be returned [Medication](medication.html): Returns medications with this external identifier [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier [MedicationStatement](medicationstatement.html): Return statements with this external identifier [MolecularSequence](molecularsequence.html): The unique identity for a particular sequence [NutritionIntake](nutritionintake.html): Return statements with this external identifier [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier [Observation](observation.html): The unique id for a particular observation [Person](person.html): A person Identifier [Procedure](procedure.html): A unique identifier for a procedure [QuestionnaireResponse](questionnaireresponse.html): The unique identifier for the questionnaire response [RelatedPerson](relatedperson.html): An Identifier of the RelatedPerson [RequestOrchestration](requestorchestration.html): External identifiers for the request orchestration [ResearchSubject](researchsubject.html): Business Identifier for research subject in a study [RiskAssessment](riskassessment.html): Unique identifier for the assessment [ServiceRequest](servicerequest.html): Identifiers assigned to this order [Specimen](specimen.html): The unique identifier associated with the specimen [SupplyDelivery](supplydelivery.html): External identifier [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest [Task](task.html): Search for a task instance by its business identifier [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier
Type: token
Path: Account.identifier | AdverseEvent.identifier | AllergyIntolerance.identifier | Appointment.identifier | AppointmentResponse.identifier | Basic.identifier | BodyStructure.identifier | CarePlan.identifier | CareTeam.identifier | ChargeItem.identifier | Claim.identifier | ClaimResponse.identifier | ClinicalImpression.identifier | Communication.identifier | CommunicationRequest.identifier | Composition.identifier | Condition.identifier | Consent.identifier | Contract.identifier | Coverage.identifier | CoverageEligibilityRequest.identifier | CoverageEligibilityResponse.identifier | DetectedIssue.identifier | DeviceRequest.identifier | DeviceUsage.identifier | DiagnosticReport.identifier | DocumentReference.identifier | Encounter.identifier | EnrollmentRequest.identifier | EpisodeOfCare.identifier | ExplanationOfBenefit.identifier | FamilyMemberHistory.identifier | Flag.identifier | Goal.identifier | GuidanceResponse.identifier | ImagingSelection.identifier | ImagingStudy.identifier | Immunization.identifier | ImmunizationEvaluation.identifier | ImmunizationRecommendation.identifier | Invoice.identifier | List.identifier | MeasureReport.identifier | Medication.identifier | MedicationAdministration.identifier | MedicationDispense.identifier | MedicationRequest.identifier | MedicationStatement.identifier | MolecularSequence.identifier | NutritionIntake.identifier | NutritionOrder.identifier | Observation.identifier | Person.identifier | Procedure.identifier | QuestionnaireResponse.identifier | RelatedPerson.identifier | RequestOrchestration.identifier | ResearchSubject.identifier | RiskAssessment.identifier | ServiceRequest.identifier | Specimen.identifier | SupplyDelivery.identifier | SupplyRequest.identifier | Task.identifier | VisionPrescription.identifier
-
SP_PATIENT
Search parameter: patientDescription: Multiple Resources: [Account](account.html): The entity that caused the expenses [AdverseEvent](adverseevent.html): Subject impacted by event [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for [Appointment](appointment.html): One of the individuals of the appointment is this patient [AppointmentResponse](appointmentresponse.html): This Response is for this Patient [AuditEvent](auditevent.html): Where the activity involved patient data [Basic](basic.html): Identifies the focus of this resource [BodyStructure](bodystructure.html): Who this is about [CarePlan](careplan.html): Who the care plan is for [CareTeam](careteam.html): Who care team is for [ChargeItem](chargeitem.html): Individual service was done for/to [Claim](claim.html): Patient receiving the products or services [ClaimResponse](claimresponse.html): The subject of care [ClinicalImpression](clinicalimpression.html): Patient assessed [Communication](communication.html): Focus of message [CommunicationRequest](communicationrequest.html): Focus of message [Composition](composition.html): Who and/or what the composition is about [Condition](condition.html): Who has the condition? [Consent](consent.html): Who the consent applies to [Contract](contract.html): The identity of the subject of the contract (if a patient) [Coverage](coverage.html): Retrieve coverages for a patient [CoverageEligibilityRequest](coverageeligibilityrequest.html): The reference to the patient [CoverageEligibilityResponse](coverageeligibilityresponse.html): The reference to the patient [DetectedIssue](detectedissue.html): Associated patient [DeviceRequest](devicerequest.html): Individual the service is ordered for [DeviceUsage](deviceusage.html): Search by patient who used / uses the device [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient [DocumentReference](documentreference.html): Who/what is the subject of the document [Encounter](encounter.html): The patient present at the encounter [EnrollmentRequest](enrollmentrequest.html): The party to be enrolled [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care [ExplanationOfBenefit](explanationofbenefit.html): The reference to the patient [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for [Flag](flag.html): The identity of a subject to list flags for [Goal](goal.html): Who this goal is intended for [GuidanceResponse](guidanceresponse.html): The identity of a patient to search for guidance response results [ImagingSelection](imagingselection.html): Who the study is about [ImagingStudy](imagingstudy.html): Who the study is about [Immunization](immunization.html): The patient for the vaccination record [ImmunizationEvaluation](immunizationevaluation.html): The patient being evaluated [ImmunizationRecommendation](immunizationrecommendation.html): Who this profile is for [Invoice](invoice.html): Recipient(s) of goods and services [List](list.html): If all resources have the same subject [MeasureReport](measurereport.html): The identity of a patient to search for individual measure report results for [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient [MedicationStatement](medicationstatement.html): Returns statements for a specific patient. [MolecularSequence](molecularsequence.html): The subject that the sequence is about [NutritionIntake](nutritionintake.html): Returns statements for a specific patient. [NutritionOrder](nutritionorder.html): The identity of the individual or set of individuals who requires the diet, formula or nutritional supplement [Observation](observation.html): The subject that the observation is about (if patient) [Person](person.html): The Person links to this Patient [Procedure](procedure.html): Search by subject - a patient [Provenance](provenance.html): Where the activity involved patient data [QuestionnaireResponse](questionnaireresponse.html): The patient that is the subject of the questionnaire response [RelatedPerson](relatedperson.html): The patient this related person is related to [RequestOrchestration](requestorchestration.html): The identity of a patient to search for request orchestrations [ResearchSubject](researchsubject.html): Who or what is part of study [RiskAssessment](riskassessment.html): Who/what does assessment apply to? [ServiceRequest](servicerequest.html): Search by subject - a patient [Specimen](specimen.html): The patient the specimen comes from [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied [SupplyRequest](supplyrequest.html): The patient or subject for whom the supply is destined [Task](task.html): Search by patient [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for
Type: reference
Path: Account.subject.where(resolve() is Patient) | AdverseEvent.subject.where(resolve() is Patient) | AllergyIntolerance.patient | Appointment.participant.actor.where(resolve() is Patient) | Appointment.subject.where(resolve() is Patient) | AppointmentResponse.actor.where(resolve() is Patient) | AuditEvent.patient | Basic.subject.where(resolve() is Patient) | BodyStructure.patient | CarePlan.subject.where(resolve() is Patient) | CareTeam.subject.where(resolve() is Patient) | ChargeItem.subject.where(resolve() is Patient) | Claim.patient | ClaimResponse.patient | ClinicalImpression.subject.where(resolve() is Patient) | Communication.subject.where(resolve() is Patient) | CommunicationRequest.subject.where(resolve() is Patient) | Composition.subject.where(resolve() is Patient) | Condition.subject.where(resolve() is Patient) | Consent.subject.where(resolve() is Patient) | Contract.subject.where(resolve() is Patient) | Coverage.beneficiary | CoverageEligibilityRequest.patient | CoverageEligibilityResponse.patient | DetectedIssue.subject.where(resolve() is Patient) | DeviceRequest.subject.where(resolve() is Patient) | DeviceUsage.patient | DiagnosticReport.subject.where(resolve() is Patient) | DocumentReference.subject.where(resolve() is Patient) | Encounter.subject.where(resolve() is Patient) | EnrollmentRequest.candidate | EpisodeOfCare.patient | ExplanationOfBenefit.patient | FamilyMemberHistory.patient | Flag.subject.where(resolve() is Patient) | Goal.subject.where(resolve() is Patient) | GuidanceResponse.subject.where(resolve() is Patient) | ImagingSelection.subject.where(resolve() is Patient) | ImagingStudy.subject.where(resolve() is Patient) | Immunization.patient | ImmunizationEvaluation.patient | ImmunizationRecommendation.patient | Invoice.subject.where(resolve() is Patient) | List.subject.where(resolve() is Patient) | MeasureReport.subject.where(resolve() is Patient) | MedicationAdministration.subject.where(resolve() is Patient) | MedicationDispense.subject.where(resolve() is Patient) | MedicationRequest.subject.where(resolve() is Patient) | MedicationStatement.subject.where(resolve() is Patient) | MolecularSequence.subject.where(resolve() is Patient) | NutritionIntake.subject.where(resolve() is Patient) | NutritionOrder.subject.where(resolve() is Patient) | Observation.subject.where(resolve() is Patient) | Person.link.target.where(resolve() is Patient) | Procedure.subject.where(resolve() is Patient) | Provenance.patient | QuestionnaireResponse.subject.where(resolve() is Patient) | RelatedPerson.patient | RequestOrchestration.subject.where(resolve() is Patient) | ResearchSubject.subject.where(resolve() is Patient) | RiskAssessment.subject.where(resolve() is Patient) | ServiceRequest.subject.where(resolve() is Patient) | Specimen.subject.where(resolve() is Patient) | SupplyDelivery.patient | SupplyRequest.deliverFor | Task.for.where(resolve() is Patient) | VisionPrescription.patient
- See Also:
-
PATIENT
Fluent Client search parameter constant for patientDescription: Multiple Resources: [Account](account.html): The entity that caused the expenses [AdverseEvent](adverseevent.html): Subject impacted by event [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for [Appointment](appointment.html): One of the individuals of the appointment is this patient [AppointmentResponse](appointmentresponse.html): This Response is for this Patient [AuditEvent](auditevent.html): Where the activity involved patient data [Basic](basic.html): Identifies the focus of this resource [BodyStructure](bodystructure.html): Who this is about [CarePlan](careplan.html): Who the care plan is for [CareTeam](careteam.html): Who care team is for [ChargeItem](chargeitem.html): Individual service was done for/to [Claim](claim.html): Patient receiving the products or services [ClaimResponse](claimresponse.html): The subject of care [ClinicalImpression](clinicalimpression.html): Patient assessed [Communication](communication.html): Focus of message [CommunicationRequest](communicationrequest.html): Focus of message [Composition](composition.html): Who and/or what the composition is about [Condition](condition.html): Who has the condition? [Consent](consent.html): Who the consent applies to [Contract](contract.html): The identity of the subject of the contract (if a patient) [Coverage](coverage.html): Retrieve coverages for a patient [CoverageEligibilityRequest](coverageeligibilityrequest.html): The reference to the patient [CoverageEligibilityResponse](coverageeligibilityresponse.html): The reference to the patient [DetectedIssue](detectedissue.html): Associated patient [DeviceRequest](devicerequest.html): Individual the service is ordered for [DeviceUsage](deviceusage.html): Search by patient who used / uses the device [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient [DocumentReference](documentreference.html): Who/what is the subject of the document [Encounter](encounter.html): The patient present at the encounter [EnrollmentRequest](enrollmentrequest.html): The party to be enrolled [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care [ExplanationOfBenefit](explanationofbenefit.html): The reference to the patient [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for [Flag](flag.html): The identity of a subject to list flags for [Goal](goal.html): Who this goal is intended for [GuidanceResponse](guidanceresponse.html): The identity of a patient to search for guidance response results [ImagingSelection](imagingselection.html): Who the study is about [ImagingStudy](imagingstudy.html): Who the study is about [Immunization](immunization.html): The patient for the vaccination record [ImmunizationEvaluation](immunizationevaluation.html): The patient being evaluated [ImmunizationRecommendation](immunizationrecommendation.html): Who this profile is for [Invoice](invoice.html): Recipient(s) of goods and services [List](list.html): If all resources have the same subject [MeasureReport](measurereport.html): The identity of a patient to search for individual measure report results for [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient [MedicationStatement](medicationstatement.html): Returns statements for a specific patient. [MolecularSequence](molecularsequence.html): The subject that the sequence is about [NutritionIntake](nutritionintake.html): Returns statements for a specific patient. [NutritionOrder](nutritionorder.html): The identity of the individual or set of individuals who requires the diet, formula or nutritional supplement [Observation](observation.html): The subject that the observation is about (if patient) [Person](person.html): The Person links to this Patient [Procedure](procedure.html): Search by subject - a patient [Provenance](provenance.html): Where the activity involved patient data [QuestionnaireResponse](questionnaireresponse.html): The patient that is the subject of the questionnaire response [RelatedPerson](relatedperson.html): The patient this related person is related to [RequestOrchestration](requestorchestration.html): The identity of a patient to search for request orchestrations [ResearchSubject](researchsubject.html): Who or what is part of study [RiskAssessment](riskassessment.html): Who/what does assessment apply to? [ServiceRequest](servicerequest.html): Search by subject - a patient [Specimen](specimen.html): The patient the specimen comes from [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied [SupplyRequest](supplyrequest.html): The patient or subject for whom the supply is destined [Task](task.html): Search by patient [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for
Type: reference
Path: Account.subject.where(resolve() is Patient) | AdverseEvent.subject.where(resolve() is Patient) | AllergyIntolerance.patient | Appointment.participant.actor.where(resolve() is Patient) | Appointment.subject.where(resolve() is Patient) | AppointmentResponse.actor.where(resolve() is Patient) | AuditEvent.patient | Basic.subject.where(resolve() is Patient) | BodyStructure.patient | CarePlan.subject.where(resolve() is Patient) | CareTeam.subject.where(resolve() is Patient) | ChargeItem.subject.where(resolve() is Patient) | Claim.patient | ClaimResponse.patient | ClinicalImpression.subject.where(resolve() is Patient) | Communication.subject.where(resolve() is Patient) | CommunicationRequest.subject.where(resolve() is Patient) | Composition.subject.where(resolve() is Patient) | Condition.subject.where(resolve() is Patient) | Consent.subject.where(resolve() is Patient) | Contract.subject.where(resolve() is Patient) | Coverage.beneficiary | CoverageEligibilityRequest.patient | CoverageEligibilityResponse.patient | DetectedIssue.subject.where(resolve() is Patient) | DeviceRequest.subject.where(resolve() is Patient) | DeviceUsage.patient | DiagnosticReport.subject.where(resolve() is Patient) | DocumentReference.subject.where(resolve() is Patient) | Encounter.subject.where(resolve() is Patient) | EnrollmentRequest.candidate | EpisodeOfCare.patient | ExplanationOfBenefit.patient | FamilyMemberHistory.patient | Flag.subject.where(resolve() is Patient) | Goal.subject.where(resolve() is Patient) | GuidanceResponse.subject.where(resolve() is Patient) | ImagingSelection.subject.where(resolve() is Patient) | ImagingStudy.subject.where(resolve() is Patient) | Immunization.patient | ImmunizationEvaluation.patient | ImmunizationRecommendation.patient | Invoice.subject.where(resolve() is Patient) | List.subject.where(resolve() is Patient) | MeasureReport.subject.where(resolve() is Patient) | MedicationAdministration.subject.where(resolve() is Patient) | MedicationDispense.subject.where(resolve() is Patient) | MedicationRequest.subject.where(resolve() is Patient) | MedicationStatement.subject.where(resolve() is Patient) | MolecularSequence.subject.where(resolve() is Patient) | NutritionIntake.subject.where(resolve() is Patient) | NutritionOrder.subject.where(resolve() is Patient) | Observation.subject.where(resolve() is Patient) | Person.link.target.where(resolve() is Patient) | Procedure.subject.where(resolve() is Patient) | Provenance.patient | QuestionnaireResponse.subject.where(resolve() is Patient) | RelatedPerson.patient | RequestOrchestration.subject.where(resolve() is Patient) | ResearchSubject.subject.where(resolve() is Patient) | RiskAssessment.subject.where(resolve() is Patient) | ServiceRequest.subject.where(resolve() is Patient) | Specimen.subject.where(resolve() is Patient) | SupplyDelivery.patient | SupplyRequest.deliverFor | Task.for.where(resolve() is Patient) | VisionPrescription.patient
-
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "Claim:patient".
-
-
Constructor Details
-
Claim
public Claim()Constructor -
Claim
public Claim(Enumerations.FinancialResourceStatusCodes status, CodeableConcept type, Enumerations.Use use, Reference patient, Date created) Constructor
-
-
Method Details
-
getIdentifier
- Returns:
identifier
(A unique identifier assigned to this claim.)
-
setIdentifier
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasIdentifier
-
addIdentifier
-
addIdentifier
-
getIdentifierFirstRep
- Returns:
- The first repetition of repeating field
identifier
, creating it if it does not already exist {3}
-
getTraceNumber
- Returns:
traceNumber
(Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.)
-
setTraceNumber
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasTraceNumber
-
addTraceNumber
-
addTraceNumber
-
getTraceNumberFirstRep
- Returns:
- The first repetition of repeating field
traceNumber
, creating it if it does not already exist {3}
-
getStatusElement
- Returns:
status
(The status of the resource instance.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
hasStatusElement
-
hasStatus
-
setStatusElement
- Parameters:
value
-status
(The status of the resource instance.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
getStatus
- Returns:
- The status of the resource instance.
-
setStatus
- Parameters:
value
- The status of the resource instance.
-
getType
- Returns:
type
(The category of claim, e.g. oral, pharmacy, vision, institutional, professional.)
-
hasType
-
setType
- Parameters:
value
-type
(The category of claim, e.g. oral, pharmacy, vision, institutional, professional.)
-
getSubType
- Returns:
subType
(A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.)
-
hasSubType
-
setSubType
- Parameters:
value
-subType
(A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.)
-
getUseElement
- Returns:
use
(A code to indicate whether the nature of the request is: Claim - A request to an Insurer to adjudicate the supplied charges for health care goods and services under the identified policy and to pay the determined Benefit amount, if any; Preauthorization - A request to an Insurer to adjudicate the supplied proposed future charges for health care goods and services under the identified policy and to approve the services and provide the expected benefit amounts and potentially to reserve funds to pay the benefits when Claims for the indicated services are later submitted; or, Pre-determination - A request to an Insurer to adjudicate the supplied 'what if' charges for health care goods and services under the identified policy and report back what the Benefit payable would be had the services actually been provided.). This is the underlying object with id, value and extensions. The accessor "getUse" gives direct access to the value
-
hasUseElement
-
hasUse
-
setUseElement
- Parameters:
value
-use
(A code to indicate whether the nature of the request is: Claim - A request to an Insurer to adjudicate the supplied charges for health care goods and services under the identified policy and to pay the determined Benefit amount, if any; Preauthorization - A request to an Insurer to adjudicate the supplied proposed future charges for health care goods and services under the identified policy and to approve the services and provide the expected benefit amounts and potentially to reserve funds to pay the benefits when Claims for the indicated services are later submitted; or, Pre-determination - A request to an Insurer to adjudicate the supplied 'what if' charges for health care goods and services under the identified policy and report back what the Benefit payable would be had the services actually been provided.). This is the underlying object with id, value and extensions. The accessor "getUse" gives direct access to the value
-
getUse
- Returns:
- A code to indicate whether the nature of the request is: Claim - A request to an Insurer to adjudicate the supplied charges for health care goods and services under the identified policy and to pay the determined Benefit amount, if any; Preauthorization - A request to an Insurer to adjudicate the supplied proposed future charges for health care goods and services under the identified policy and to approve the services and provide the expected benefit amounts and potentially to reserve funds to pay the benefits when Claims for the indicated services are later submitted; or, Pre-determination - A request to an Insurer to adjudicate the supplied 'what if' charges for health care goods and services under the identified policy and report back what the Benefit payable would be had the services actually been provided.
-
setUse
- Parameters:
value
- A code to indicate whether the nature of the request is: Claim - A request to an Insurer to adjudicate the supplied charges for health care goods and services under the identified policy and to pay the determined Benefit amount, if any; Preauthorization - A request to an Insurer to adjudicate the supplied proposed future charges for health care goods and services under the identified policy and to approve the services and provide the expected benefit amounts and potentially to reserve funds to pay the benefits when Claims for the indicated services are later submitted; or, Pre-determination - A request to an Insurer to adjudicate the supplied 'what if' charges for health care goods and services under the identified policy and report back what the Benefit payable would be had the services actually been provided.
-
getPatient
- Returns:
patient
(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.)
-
hasPatient
-
setPatient
- Parameters:
value
-patient
(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.)
-
getBillablePeriod
- Returns:
billablePeriod
(The period for which charges are being submitted.)
-
hasBillablePeriod
-
setBillablePeriod
- Parameters:
value
-billablePeriod
(The period for which charges are being submitted.)
-
getCreatedElement
- Returns:
created
(The date this resource was created.). This is the underlying object with id, value and extensions. The accessor "getCreated" gives direct access to the value
-
hasCreatedElement
-
hasCreated
-
setCreatedElement
- Parameters:
value
-created
(The date this resource was created.). This is the underlying object with id, value and extensions. The accessor "getCreated" gives direct access to the value
-
getCreated
- Returns:
- The date this resource was created.
-
setCreated
- Parameters:
value
- The date this resource was created.
-
getEnterer
- Returns:
enterer
(Individual who created the claim, predetermination or preauthorization.)
-
hasEnterer
-
setEnterer
- Parameters:
value
-enterer
(Individual who created the claim, predetermination or preauthorization.)
-
getInsurer
- Returns:
insurer
(The Insurer who is target of the request.)
-
hasInsurer
-
setInsurer
- Parameters:
value
-insurer
(The Insurer who is target of the request.)
-
getProvider
- Returns:
provider
(The provider which is responsible for the claim, predetermination or preauthorization.)
-
hasProvider
-
setProvider
- Parameters:
value
-provider
(The provider which is responsible for the claim, predetermination or preauthorization.)
-
getPriority
- Returns:
priority
(The provider-required urgency of processing the request. Typical values include: stat, normal, deferred.)
-
hasPriority
-
setPriority
- Parameters:
value
-priority
(The provider-required urgency of processing the request. Typical values include: stat, normal, deferred.)
-
getFundsReserve
- Returns:
fundsReserve
(A code to indicate whether and for whom funds are to be reserved for future claims.)
-
hasFundsReserve
-
setFundsReserve
- Parameters:
value
-fundsReserve
(A code to indicate whether and for whom funds are to be reserved for future claims.)
-
getRelated
- Returns:
related
(Other claims which are related to this claim such as prior submissions or claims for related services or for the same event.)
-
setRelated
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasRelated
-
addRelated
-
addRelated
-
getRelatedFirstRep
- Returns:
- The first repetition of repeating field
related
, creating it if it does not already exist {3}
-
getPrescription
- Returns:
prescription
(Prescription is the document/authorization given to the claim author for them to provide products and services for which consideration (reimbursement) is sought. Could be a RX for medications, an 'order' for oxygen or wheelchair or physiotherapy treatments.)
-
hasPrescription
-
setPrescription
- Parameters:
value
-prescription
(Prescription is the document/authorization given to the claim author for them to provide products and services for which consideration (reimbursement) is sought. Could be a RX for medications, an 'order' for oxygen or wheelchair or physiotherapy treatments.)
-
getOriginalPrescription
- Returns:
originalPrescription
(Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products.)
-
hasOriginalPrescription
-
setOriginalPrescription
- Parameters:
value
-originalPrescription
(Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products.)
-
getPayee
- Returns:
payee
(The party to be reimbursed for cost of the products and services according to the terms of the policy.)
-
hasPayee
-
setPayee
- Parameters:
value
-payee
(The party to be reimbursed for cost of the products and services according to the terms of the policy.)
-
getReferral
- Returns:
referral
(The referral information received by the claim author, it is not to be used when the author generates a referral for a patient. A copy of that referral may be provided as supporting information. Some insurers require proof of referral to pay for services or to pay specialist rates for services.)
-
hasReferral
-
setReferral
- Parameters:
value
-referral
(The referral information received by the claim author, it is not to be used when the author generates a referral for a patient. A copy of that referral may be provided as supporting information. Some insurers require proof of referral to pay for services or to pay specialist rates for services.)
-
getEncounter
- Returns:
encounter
(Healthcare encounters related to this claim.)
-
setEncounter
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasEncounter
-
addEncounter
-
addEncounter
-
getEncounterFirstRep
- Returns:
- The first repetition of repeating field
encounter
, creating it if it does not already exist {3}
-
getFacility
- Returns:
facility
(Facility where the services were provided.)
-
hasFacility
-
setFacility
- Parameters:
value
-facility
(Facility where the services were provided.)
-
getDiagnosisRelatedGroup
- Returns:
diagnosisRelatedGroup
(A package billing code or bundle code used to group products and services to a particular health condition (such as heart attack) which is based on a predetermined grouping code system.)
-
hasDiagnosisRelatedGroup
-
setDiagnosisRelatedGroup
- Parameters:
value
-diagnosisRelatedGroup
(A package billing code or bundle code used to group products and services to a particular health condition (such as heart attack) which is based on a predetermined grouping code system.)
-
getEvent
- Returns:
event
(Information code for an event with a corresponding date or period.)
-
setEvent
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasEvent
-
addEvent
-
addEvent
-
getEventFirstRep
- Returns:
- The first repetition of repeating field
event
, creating it if it does not already exist {3}
-
getCareTeam
- Returns:
careTeam
(The members of the team who provided the products and services.)
-
setCareTeam
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasCareTeam
-
addCareTeam
-
addCareTeam
-
getCareTeamFirstRep
- Returns:
- The first repetition of repeating field
careTeam
, creating it if it does not already exist {3}
-
getSupportingInfo
- Returns:
supportingInfo
(Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues.)
-
setSupportingInfo
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasSupportingInfo
-
addSupportingInfo
-
addSupportingInfo
-
getSupportingInfoFirstRep
- Returns:
- The first repetition of repeating field
supportingInfo
, creating it if it does not already exist {3}
-
getDiagnosis
- Returns:
diagnosis
(Information about diagnoses relevant to the claim items.)
-
setDiagnosis
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasDiagnosis
-
addDiagnosis
-
addDiagnosis
-
getDiagnosisFirstRep
- Returns:
- The first repetition of repeating field
diagnosis
, creating it if it does not already exist {3}
-
getProcedure
- Returns:
procedure
(Procedures performed on the patient relevant to the billing items with the claim.)
-
setProcedure
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasProcedure
-
addProcedure
-
addProcedure
-
getProcedureFirstRep
- Returns:
- The first repetition of repeating field
procedure
, creating it if it does not already exist {3}
-
getInsurance
- Returns:
insurance
(Financial instruments for reimbursement for the health care products and services specified on the claim.)
-
setInsurance
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasInsurance
-
addInsurance
-
addInsurance
-
getInsuranceFirstRep
- Returns:
- The first repetition of repeating field
insurance
, creating it if it does not already exist {3}
-
getAccident
- Returns:
accident
(Details of an accident which resulted in injuries which required the products and services listed in the claim.)
-
hasAccident
-
setAccident
- Parameters:
value
-accident
(Details of an accident which resulted in injuries which required the products and services listed in the claim.)
-
getPatientPaid
- Returns:
patientPaid
(The amount paid by the patient, in total at the claim claim level or specifically for the item and detail level, to the provider for goods and services.)
-
hasPatientPaid
-
setPatientPaid
- Parameters:
value
-patientPaid
(The amount paid by the patient, in total at the claim claim level or specifically for the item and detail level, to the provider for goods and services.)
-
getItem
- Returns:
item
(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.)
-
setItem
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasItem
-
addItem
-
addItem
-
getItemFirstRep
- Returns:
- The first repetition of repeating field
item
, creating it if it does not already exist {3}
-
getTotal
- Returns:
total
(The total value of the all the items in the claim.)
-
hasTotal
-
setTotal
- Parameters:
value
-total
(The total value of the all the items in the claim.)
-
listChildren
- Overrides:
listChildren
in classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
removeChild
- Overrides:
removeChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makeProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classDomainResource
- Returns:
- the FHIR type name of the instance (not the java class name)
-
copy
- Specified by:
copy
in classDomainResource
-
copyValues
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeep
in classDomainResource
-
equalsShallow
- Overrides:
equalsShallow
in classDomainResource
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classDomainResource
-
getResourceType
- Specified by:
getResourceType
in classResource
-