
Class Provenance
- 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
Nested ClassesModifier and TypeClassDescriptionstatic classstatic classstatic enumstatic classNested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base
Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected CodeableConceptAn activity is something that occurs over a period of time and acts upon or with entities; it may include consuming, processing, transforming, modifying, relocating, using, or generating entities.static final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for activityprotected List<Provenance.ProvenanceAgentComponent> An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.static final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for agentstatic final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for agent-rolestatic final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for agent-typeprotected List<CodeableReference> The authorization (e.g., PurposeOfUse) that was used during the event being recorded.static final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for based-onAllows tracing of authorizatino for the events and tracking whether proposals/recommendations were acted upon.protected ReferenceThis will typically be the encounter the event occurred, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission lab tests).static final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for encounterprotected List<Provenance.ProvenanceEntityComponent> An entity used in this activity.static final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for entitystatic final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.protected ReferenceWhere the activity occurred, if relevant.static final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for locationprotected DataTypeThe period during which the activity occurred.protected ReferenceThe patient element is available to enable deterministic tracking of activities that involve the patient as the subject of the data used in an activity.static final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for patientPolicy or plan the activity was defined by.protected InstantTypeThe instant of time at which the activity was recorded.static final ca.uhn.fhir.rest.gclient.DateClientParamFluent Client search parameter constant for recordedA digital signature on the target Reference(s).static final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for signature-typestatic final StringSearch parameter: activitystatic final StringSearch parameter: agentstatic final StringSearch parameter: agent-rolestatic final StringSearch parameter: agent-typestatic final StringSearch parameter: based-onstatic final StringSearch parameter: encounterstatic final StringSearch parameter: entitystatic final StringSearch parameter: locationstatic final StringSearch parameter: patientstatic final StringSearch parameter: recordedstatic final StringSearch parameter: signature-typestatic final StringSearch parameter: targetstatic final StringSearch parameter: whenThe Reference(s) that were generated or updated by the activity described in this resource.static final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for targetstatic final ca.uhn.fhir.rest.gclient.DateClientParamFluent Client search parameter constant for whenFields inherited from class org.hl7.fhir.r5.model.DomainResource
contained, extension, modifierExtension, SP_TEXT, text, TEXTFields inherited from class org.hl7.fhir.r5.model.Resource
id, implicitRules, language, metaFields 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_TAGFields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET -
Constructor Summary
ConstructorsConstructorDescriptionConstructorProvenance(Reference target, Provenance.ProvenanceAgentComponent agent) Constructor -
Method Summary
Modifier and TypeMethodDescriptionaddAgent()copy()voidcopyValues(Provenance dst) booleanequalsDeep(Base other_) booleanequalsShallow(Base other_) fhirType()getAgent()getNamedProperty(int _hash, String _name, boolean _checkValid) Base[]getProperty(int hash, String name, boolean checkValid) String[]getTypesForProperty(int hash, String name) booleanbooleanhasAgent()booleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanisEmpty()protected voidlistChildren(List<Property> children) makeProperty(int hash, String name) voidremoveChild(String name, Base value) setActivity(CodeableConcept value) setAgent(List<Provenance.ProvenanceAgentComponent> theAgent) setAuthorization(List<CodeableReference> theAuthorization) setBasedOn(List<Reference> theBasedOn) setEncounter(Reference value) setEntity(List<Provenance.ProvenanceEntityComponent> theEntity) setLocation(Reference value) setOccurred(DataType value) setPatient(Reference value) setProperty(int hash, String name, Base value) setProperty(String name, Base value) setRecorded(Date value) setRecordedElement(InstantType value) setSignature(List<Signature> theSignature) protected ProvenanceMethods inherited from class org.hl7.fhir.r5.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getExtensionsByUrl, getExtensionString, getExtensionString, getModifierExtension, getModifierExtensionsByUrl, getStandardsStatus, getText, hasContained, hasExtension, hasExtension, hasExtension, hasModifierExtension, hasPrimitiveExtension, hasText, setContained, setExtension, setModifierExtension, setStandardsStatus, setTextMethods 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, setWebPathMethods inherited from class org.hl7.fhir.r5.model.BaseResource
getStructureFhirVersionEnum, isResource, setIdMethods 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, executeFunction, 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, setXhtmlMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserDataMethods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatCommentMethods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, isDeleted, setId
-
Field Details
-
target
The Reference(s) that were generated or updated by the activity described in this resource. A provenance can point to more than one target if multiple resources were created/updated by the same activity. -
occurred
The period during which the activity occurred. -
recorded
The instant of time at which the activity was recorded. -
policy
Policy or plan the activity was defined by. Typically, a single activity may have multiple applicable policy documents, such as patient consent, guarantor funding, etc. -
location
Where the activity occurred, if relevant. -
authorization
The authorization (e.g., PurposeOfUse) that was used during the event being recorded. -
activity
An activity is something that occurs over a period of time and acts upon or with entities; it may include consuming, processing, transforming, modifying, relocating, using, or generating entities. -
basedOn
Allows tracing of authorizatino for the events and tracking whether proposals/recommendations were acted upon. -
patient
The patient element is available to enable deterministic tracking of activities that involve the patient as the subject of the data used in an activity. -
encounter
This will typically be the encounter the event occurred, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission lab tests). -
agent
An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place. -
entity
An entity used in this activity. -
signature
A digital signature on the target Reference(s). The signer should match a Provenance.agent. The purpose of the signature is indicated. -
SP_ACTIVITY
Search parameter: activityDescription: Activity that occurred
Type: token
Path: Provenance.activity
- See Also:
-
ACTIVITY
Fluent Client search parameter constant for activityDescription: Activity that occurred
Type: token
Path: Provenance.activity
-
SP_AGENT_ROLE
Search parameter: agent-roleDescription: What the agents role was
Type: token
Path: Provenance.agent.role
- See Also:
-
AGENT_ROLE
Fluent Client search parameter constant for agent-roleDescription: What the agents role was
Type: token
Path: Provenance.agent.role
-
SP_AGENT_TYPE
Search parameter: agent-typeDescription: How the agent participated
Type: token
Path: Provenance.agent.type
- See Also:
-
AGENT_TYPE
Fluent Client search parameter constant for agent-typeDescription: How the agent participated
Type: token
Path: Provenance.agent.type
-
SP_AGENT
Search parameter: agentDescription: Who participated
Type: reference
Path: Provenance.agent.who
- See Also:
-
AGENT
Fluent Client search parameter constant for agentDescription: Who participated
Type: reference
Path: Provenance.agent.who
-
INCLUDE_AGENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "Provenance:agent". -
SP_BASED_ON
Search parameter: based-onDescription: Reference to the service request.
Type: reference
Path: Provenance.basedOn
- See Also:
-
BASED_ON
Fluent Client search parameter constant for based-onDescription: Reference to the service request.
Type: reference
Path: Provenance.basedOn
-
INCLUDE_BASED_ON
Constant for fluent queries to be used to add include statements. Specifies the path value of "Provenance:based-on". -
SP_ENTITY
Search parameter: entityDescription: Identity of entity
Type: reference
Path: Provenance.entity.what
- See Also:
-
ENTITY
Fluent Client search parameter constant for entityDescription: Identity of entity
Type: reference
Path: Provenance.entity.what
-
INCLUDE_ENTITY
Constant for fluent queries to be used to add include statements. Specifies the path value of "Provenance:entity". -
SP_LOCATION
Search parameter: locationDescription: Where the activity occurred, if relevant
Type: reference
Path: Provenance.location
- See Also:
-
LOCATION
Fluent Client search parameter constant for locationDescription: Where the activity occurred, if relevant
Type: reference
Path: Provenance.location
-
INCLUDE_LOCATION
Constant for fluent queries to be used to add include statements. Specifies the path value of "Provenance:location". -
SP_RECORDED
Search parameter: recordedDescription: When the activity was recorded / updated
Type: date
Path: Provenance.recorded
- See Also:
-
RECORDED
Fluent Client search parameter constant for recordedDescription: When the activity was recorded / updated
Type: date
Path: Provenance.recorded
-
SP_SIGNATURE_TYPE
Search parameter: signature-typeDescription: Indication of the reason the entity signed the object(s)
Type: token
Path: Provenance.signature.type
- See Also:
-
SIGNATURE_TYPE
Fluent Client search parameter constant for signature-typeDescription: Indication of the reason the entity signed the object(s)
Type: token
Path: Provenance.signature.type
-
SP_TARGET
Search parameter: targetDescription: Target Reference(s) (usually version specific)
Type: reference
Path: Provenance.target
- See Also:
-
TARGET
Fluent Client search parameter constant for targetDescription: Target Reference(s) (usually version specific)
Type: reference
Path: Provenance.target
-
INCLUDE_TARGET
Constant for fluent queries to be used to add include statements. Specifies the path value of "Provenance:target". -
SP_WHEN
Search parameter: whenDescription: When the activity occurred
Type: date
Path: (Provenance.occurred.ofType(dateTime))
- See Also:
-
WHEN
Fluent Client search parameter constant for whenDescription: When the activity occurred
Type: date
Path: (Provenance.occurred.ofType(dateTime))
-
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 "Provenance:encounter". -
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 "Provenance:patient".
-
-
Constructor Details
-
Provenance
public Provenance()Constructor -
Provenance
Constructor
-
-
Method Details
-
getTarget
- Returns:
target(The Reference(s) that were generated or updated by the activity described in this resource. A provenance can point to more than one target if multiple resources were created/updated by the same activity.)
-
setTarget
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasTarget
-
addTarget
-
addTarget
-
getTargetFirstRep
- Returns:
- The first repetition of repeating field
target, creating it if it does not already exist {3}
-
getOccurred
- Returns:
occurred(The period during which the activity occurred.)
-
getOccurredPeriod
- Returns:
occurred(The period during which the activity occurred.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasOccurredPeriod
-
getOccurredDateTimeType
- Returns:
occurred(The period during which the activity occurred.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasOccurredDateTimeType
-
hasOccurred
-
setOccurred
- Parameters:
value-occurred(The period during which the activity occurred.)
-
getRecordedElement
- Returns:
recorded(The instant of time at which the activity was recorded.). This is the underlying object with id, value and extensions. The accessor "getRecorded" gives direct access to the value
-
hasRecordedElement
-
hasRecorded
-
setRecordedElement
- Parameters:
value-recorded(The instant of time at which the activity was recorded.). This is the underlying object with id, value and extensions. The accessor "getRecorded" gives direct access to the value
-
getRecorded
- Returns:
- The instant of time at which the activity was recorded.
-
setRecorded
- Parameters:
value- The instant of time at which the activity was recorded.
-
getPolicy
- Returns:
policy(Policy or plan the activity was defined by. Typically, a single activity may have multiple applicable policy documents, such as patient consent, guarantor funding, etc.)
-
setPolicy
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasPolicy
-
addPolicyElement
- Returns:
policy(Policy or plan the activity was defined by. Typically, a single activity may have multiple applicable policy documents, such as patient consent, guarantor funding, etc.)
-
addPolicy
- Parameters:
value-policy(Policy or plan the activity was defined by. Typically, a single activity may have multiple applicable policy documents, such as patient consent, guarantor funding, etc.)
-
hasPolicy
- Parameters:
value-policy(Policy or plan the activity was defined by. Typically, a single activity may have multiple applicable policy documents, such as patient consent, guarantor funding, etc.)
-
getLocation
- Returns:
location(Where the activity occurred, if relevant.)
-
hasLocation
-
setLocation
- Parameters:
value-location(Where the activity occurred, if relevant.)
-
getAuthorization
- Returns:
authorization(The authorization (e.g., PurposeOfUse) that was used during the event being recorded.)
-
setAuthorization
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasAuthorization
-
addAuthorization
-
addAuthorization
-
getAuthorizationFirstRep
- Returns:
- The first repetition of repeating field
authorization, creating it if it does not already exist {3}
-
getActivity
- Returns:
activity(An activity is something that occurs over a period of time and acts upon or with entities; it may include consuming, processing, transforming, modifying, relocating, using, or generating entities.)
-
hasActivity
-
setActivity
- Parameters:
value-activity(An activity is something that occurs over a period of time and acts upon or with entities; it may include consuming, processing, transforming, modifying, relocating, using, or generating entities.)
-
getBasedOn
- Returns:
basedOn(Allows tracing of authorizatino for the events and tracking whether proposals/recommendations were acted upon.)
-
setBasedOn
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasBasedOn
-
addBasedOn
-
addBasedOn
-
getBasedOnFirstRep
- Returns:
- The first repetition of repeating field
basedOn, creating it if it does not already exist {3}
-
getPatient
- Returns:
patient(The patient element is available to enable deterministic tracking of activities that involve the patient as the subject of the data used in an activity.)
-
hasPatient
-
setPatient
- Parameters:
value-patient(The patient element is available to enable deterministic tracking of activities that involve the patient as the subject of the data used in an activity.)
-
getEncounter
- Returns:
encounter(This will typically be the encounter the event occurred, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission lab tests).)
-
hasEncounter
-
setEncounter
- Parameters:
value-encounter(This will typically be the encounter the event occurred, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission lab tests).)
-
getAgent
- Returns:
agent(An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.)
-
setAgent
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasAgent
-
addAgent
-
addAgent
-
getAgentFirstRep
- Returns:
- The first repetition of repeating field
agent, creating it if it does not already exist {3}
-
getEntity
- Returns:
entity(An entity used in this activity.)
-
setEntity
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasEntity
-
addEntity
-
addEntity
-
getEntityFirstRep
- Returns:
- The first repetition of repeating field
entity, creating it if it does not already exist {3}
-
getSignature
- Returns:
signature(A digital signature on the target Reference(s). The signer should match a Provenance.agent. The purpose of the signature is indicated.)
-
setSignature
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasSignature
-
addSignature
-
addSignature
-
getSignatureFirstRep
- Returns:
- The first repetition of repeating field
signature, creating it if it does not already exist {3}
-
listChildren
- Overrides:
listChildrenin classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
removeChild
- Overrides:
removeChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makePropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classDomainResource- Returns:
- the FHIR type name of the instance (not the java class name)
-
copy
- Specified by:
copyin classDomainResource
-
copyValues
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeepin classDomainResource
-
equalsShallow
- Overrides:
equalsShallowin classDomainResource
-
isEmpty
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classDomainResource
-
getResourceType
- Specified by:
getResourceTypein classResource
-