Package org.hl7.fhir.r5.model

Class RelatedPerson

java.lang.Object
org.hl7.fhir.r5.model.Base
org.hl7.fhir.r5.model.BaseResource
org.hl7.fhir.r5.model.Resource
org.hl7.fhir.r5.model.DomainResource
org.hl7.fhir.r5.model.RelatedPerson
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
public class RelatedPerson extends DomainResource
Information about a person that is involved in a patient's health or the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.
See Also:

  • Field Details

    • identifier

      protected List<Identifier> identifier
      Identifier for a person within a particular scope.

    • active

      protected BooleanType active
      Whether this related person record is in active use.

    • patient

      protected Reference patient
      The patient this person is related to.

    • relationship

      protected List<CodeableConcept> relationship
      The nature of the relationship between the related person and the patient.

    • name

      protected List<HumanName> name
      A name associated with the person.

    • telecom

      protected List<ContactPoint> telecom
      A contact detail for the person, e.g. a telephone number or an email address.

    • gender

      protected Enumeration<Enumerations.AdministrativeGender> gender
      Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.

    • birthDate

      protected DateType birthDate
      The date on which the related person was born.

    • address

      protected List<Address> address
      Address where the related person can be contacted or visited.

    • photo

      protected List<Attachment> photo
      Image of the person.

    • period

      protected Period period
      The period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknown.

    • communication

      protected List<RelatedPerson.RelatedPersonCommunicationComponent> communication
      A language which may be used to communicate with the related person about the patient's health.

    • SP_ACTIVE

      public static final String SP_ACTIVE
      Search parameter: active

      Description: Indicates if the related person record is active
      Type: token
      Path: RelatedPerson.active

      See Also:

    • ACTIVE

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam ACTIVE
      Fluent Client search parameter constant for active

      Description: Indicates if the related person record is active
      Type: token
      Path: RelatedPerson.active

    • SP_FAMILY

      public static final String SP_FAMILY
      Search parameter: family

      Description: A portion of the family name of the related person
      Type: string
      Path: RelatedPerson.name.family

      See Also:

    • FAMILY

      public static final ca.uhn.fhir.rest.gclient.StringClientParam FAMILY
      Fluent Client search parameter constant for family

      Description: A portion of the family name of the related person
      Type: string
      Path: RelatedPerson.name.family

    • SP_GIVEN

      public static final String SP_GIVEN
      Search parameter: given

      Description: A portion of the given name of the related person
      Type: string
      Path: RelatedPerson.name.given

      See Also:

    • GIVEN

      public static final ca.uhn.fhir.rest.gclient.StringClientParam GIVEN
      Fluent Client search parameter constant for given

      Description: A portion of the given name of the related person
      Type: string
      Path: RelatedPerson.name.given

    • SP_NAME

      public static final String SP_NAME
      Search parameter: name

      Description: A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text
      Type: string
      Path: RelatedPerson.name

      See Also:

    • NAME

      public static final ca.uhn.fhir.rest.gclient.StringClientParam NAME
      Fluent Client search parameter constant for name

      Description: A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text
      Type: string
      Path: RelatedPerson.name

    • SP_RELATIONSHIP

      public static final String SP_RELATIONSHIP
      Search parameter: relationship

      Description: The relationship between the patient and the relatedperson
      Type: token
      Path: RelatedPerson.relationship

      See Also:

    • RELATIONSHIP

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam RELATIONSHIP
      Fluent Client search parameter constant for relationship

      Description: The relationship between the patient and the relatedperson
      Type: token
      Path: RelatedPerson.relationship

    • SP_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter: identifier

      Description: 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

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
      Fluent Client search parameter constant for identifier

      Description: 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

      public static final String SP_PATIENT
      Search parameter: patient

      Description: 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

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
      Fluent Client search parameter constant for patient

      Description: 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

      public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT
      Constant for fluent queries to be used to add include statements. Specifies the path value of "RelatedPerson:patient".

    • SP_ADDRESS_CITY

      public static final String SP_ADDRESS_CITY
      Search parameter: address-city

      Description: Multiple Resources: [Patient](patient.html): A city specified in an address [Person](person.html): A city specified in an address [Practitioner](practitioner.html): A city specified in an address [RelatedPerson](relatedperson.html): A city specified in an address
      Type: string
      Path: Patient.address.city | Person.address.city | Practitioner.address.city | RelatedPerson.address.city

      See Also:

    • ADDRESS_CITY

      public static final ca.uhn.fhir.rest.gclient.StringClientParam ADDRESS_CITY
      Fluent Client search parameter constant for address-city

      Description: Multiple Resources: [Patient](patient.html): A city specified in an address [Person](person.html): A city specified in an address [Practitioner](practitioner.html): A city specified in an address [RelatedPerson](relatedperson.html): A city specified in an address
      Type: string
      Path: Patient.address.city | Person.address.city | Practitioner.address.city | RelatedPerson.address.city

    • SP_ADDRESS_COUNTRY

      public static final String SP_ADDRESS_COUNTRY
      Search parameter: address-country

      Description: Multiple Resources: [Patient](patient.html): A country specified in an address [Person](person.html): A country specified in an address [Practitioner](practitioner.html): A country specified in an address [RelatedPerson](relatedperson.html): A country specified in an address
      Type: string
      Path: Patient.address.country | Person.address.country | Practitioner.address.country | RelatedPerson.address.country

      See Also:

    • ADDRESS_COUNTRY

      public static final ca.uhn.fhir.rest.gclient.StringClientParam ADDRESS_COUNTRY
      Fluent Client search parameter constant for address-country

      Description: Multiple Resources: [Patient](patient.html): A country specified in an address [Person](person.html): A country specified in an address [Practitioner](practitioner.html): A country specified in an address [RelatedPerson](relatedperson.html): A country specified in an address
      Type: string
      Path: Patient.address.country | Person.address.country | Practitioner.address.country | RelatedPerson.address.country

    • SP_ADDRESS_POSTALCODE

      public static final String SP_ADDRESS_POSTALCODE
      Search parameter: address-postalcode

      Description: Multiple Resources: [Patient](patient.html): A postalCode specified in an address [Person](person.html): A postal code specified in an address [Practitioner](practitioner.html): A postalCode specified in an address [RelatedPerson](relatedperson.html): A postal code specified in an address
      Type: string
      Path: Patient.address.postalCode | Person.address.postalCode | Practitioner.address.postalCode | RelatedPerson.address.postalCode

      See Also:

    • ADDRESS_POSTALCODE

      public static final ca.uhn.fhir.rest.gclient.StringClientParam ADDRESS_POSTALCODE
      Fluent Client search parameter constant for address-postalcode

      Description: Multiple Resources: [Patient](patient.html): A postalCode specified in an address [Person](person.html): A postal code specified in an address [Practitioner](practitioner.html): A postalCode specified in an address [RelatedPerson](relatedperson.html): A postal code specified in an address
      Type: string
      Path: Patient.address.postalCode | Person.address.postalCode | Practitioner.address.postalCode | RelatedPerson.address.postalCode

    • SP_ADDRESS_STATE

      public static final String SP_ADDRESS_STATE
      Search parameter: address-state

      Description: Multiple Resources: [Patient](patient.html): A state specified in an address [Person](person.html): A state specified in an address [Practitioner](practitioner.html): A state specified in an address [RelatedPerson](relatedperson.html): A state specified in an address
      Type: string
      Path: Patient.address.state | Person.address.state | Practitioner.address.state | RelatedPerson.address.state

      See Also:

    • ADDRESS_STATE

      public static final ca.uhn.fhir.rest.gclient.StringClientParam ADDRESS_STATE
      Fluent Client search parameter constant for address-state

      Description: Multiple Resources: [Patient](patient.html): A state specified in an address [Person](person.html): A state specified in an address [Practitioner](practitioner.html): A state specified in an address [RelatedPerson](relatedperson.html): A state specified in an address
      Type: string
      Path: Patient.address.state | Person.address.state | Practitioner.address.state | RelatedPerson.address.state

    • SP_ADDRESS_USE

      public static final String SP_ADDRESS_USE
      Search parameter: address-use

      Description: Multiple Resources: [Patient](patient.html): A use code specified in an address [Person](person.html): A use code specified in an address [Practitioner](practitioner.html): A use code specified in an address [RelatedPerson](relatedperson.html): A use code specified in an address
      Type: token
      Path: Patient.address.use | Person.address.use | Practitioner.address.use | RelatedPerson.address.use

      See Also:

    • ADDRESS_USE

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam ADDRESS_USE
      Fluent Client search parameter constant for address-use

      Description: Multiple Resources: [Patient](patient.html): A use code specified in an address [Person](person.html): A use code specified in an address [Practitioner](practitioner.html): A use code specified in an address [RelatedPerson](relatedperson.html): A use code specified in an address
      Type: token
      Path: Patient.address.use | Person.address.use | Practitioner.address.use | RelatedPerson.address.use

    • SP_ADDRESS

      public static final String SP_ADDRESS
      Search parameter: address

      Description: Multiple Resources: [Patient](patient.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text [Person](person.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text [Practitioner](practitioner.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text [RelatedPerson](relatedperson.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text
      Type: string
      Path: Patient.address | Person.address | Practitioner.address | RelatedPerson.address

      See Also:

    • ADDRESS

      public static final ca.uhn.fhir.rest.gclient.StringClientParam ADDRESS
      Fluent Client search parameter constant for address

      Description: Multiple Resources: [Patient](patient.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text [Person](person.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text [Practitioner](practitioner.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text [RelatedPerson](relatedperson.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text
      Type: string
      Path: Patient.address | Person.address | Practitioner.address | RelatedPerson.address

    • SP_BIRTHDATE

      public static final String SP_BIRTHDATE
      Search parameter: birthdate

      Description: Multiple Resources: [Patient](patient.html): The patient's date of birth [Person](person.html): The person's date of birth [RelatedPerson](relatedperson.html): The Related Person's date of birth
      Type: date
      Path: Patient.birthDate | Person.birthDate | RelatedPerson.birthDate

      See Also:

    • BIRTHDATE

      public static final ca.uhn.fhir.rest.gclient.DateClientParam BIRTHDATE
      Fluent Client search parameter constant for birthdate

      Description: Multiple Resources: [Patient](patient.html): The patient's date of birth [Person](person.html): The person's date of birth [RelatedPerson](relatedperson.html): The Related Person's date of birth
      Type: date
      Path: Patient.birthDate | Person.birthDate | RelatedPerson.birthDate

    • SP_EMAIL

      public static final String SP_EMAIL
      Search parameter: email

      Description: Multiple Resources: [Patient](patient.html): A value in an email contact [Person](person.html): A value in an email contact [Practitioner](practitioner.html): A value in an email contact [PractitionerRole](practitionerrole.html): A value in an email contact [RelatedPerson](relatedperson.html): A value in an email contact
      Type: token
      Path: Patient.telecom.where(system='email') | Person.telecom.where(system='email') | Practitioner.telecom.where(system='email') | PractitionerRole.contact.telecom.where(system='email') | RelatedPerson.telecom.where(system='email')

      See Also:

    • EMAIL

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam EMAIL
      Fluent Client search parameter constant for email

      Description: Multiple Resources: [Patient](patient.html): A value in an email contact [Person](person.html): A value in an email contact [Practitioner](practitioner.html): A value in an email contact [PractitionerRole](practitionerrole.html): A value in an email contact [RelatedPerson](relatedperson.html): A value in an email contact
      Type: token
      Path: Patient.telecom.where(system='email') | Person.telecom.where(system='email') | Practitioner.telecom.where(system='email') | PractitionerRole.contact.telecom.where(system='email') | RelatedPerson.telecom.where(system='email')

    • SP_GENDER

      public static final String SP_GENDER
      Search parameter: gender

      Description: Multiple Resources: [Patient](patient.html): Gender of the patient [Person](person.html): The gender of the person [Practitioner](practitioner.html): Gender of the practitioner [RelatedPerson](relatedperson.html): Gender of the related person
      Type: token
      Path: Patient.gender | Person.gender | Practitioner.gender | RelatedPerson.gender

      See Also:

    • GENDER

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam GENDER
      Fluent Client search parameter constant for gender

      Description: Multiple Resources: [Patient](patient.html): Gender of the patient [Person](person.html): The gender of the person [Practitioner](practitioner.html): Gender of the practitioner [RelatedPerson](relatedperson.html): Gender of the related person
      Type: token
      Path: Patient.gender | Person.gender | Practitioner.gender | RelatedPerson.gender

    • SP_PHONE

      public static final String SP_PHONE
      Search parameter: phone

      Description: Multiple Resources: [Patient](patient.html): A value in a phone contact [Person](person.html): A value in a phone contact [Practitioner](practitioner.html): A value in a phone contact [PractitionerRole](practitionerrole.html): A value in a phone contact [RelatedPerson](relatedperson.html): A value in a phone contact
      Type: token
      Path: Patient.telecom.where(system='phone') | Person.telecom.where(system='phone') | Practitioner.telecom.where(system='phone') | PractitionerRole.contact.telecom.where(system='phone') | RelatedPerson.telecom.where(system='phone')

      See Also:

    • PHONE

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam PHONE
      Fluent Client search parameter constant for phone

      Description: Multiple Resources: [Patient](patient.html): A value in a phone contact [Person](person.html): A value in a phone contact [Practitioner](practitioner.html): A value in a phone contact [PractitionerRole](practitionerrole.html): A value in a phone contact [RelatedPerson](relatedperson.html): A value in a phone contact
      Type: token
      Path: Patient.telecom.where(system='phone') | Person.telecom.where(system='phone') | Practitioner.telecom.where(system='phone') | PractitionerRole.contact.telecom.where(system='phone') | RelatedPerson.telecom.where(system='phone')

    • SP_PHONETIC

      public static final String SP_PHONETIC
      Search parameter: phonetic

      Description: Multiple Resources: [Patient](patient.html): A portion of either family or given name using some kind of phonetic matching algorithm [Person](person.html): A portion of name using some kind of phonetic matching algorithm [Practitioner](practitioner.html): A portion of either family or given name using some kind of phonetic matching algorithm [RelatedPerson](relatedperson.html): A portion of name using some kind of phonetic matching algorithm
      Type: string
      Path: Patient.name | Person.name | Practitioner.name | RelatedPerson.name

      See Also:

    • PHONETIC

      public static final ca.uhn.fhir.rest.gclient.StringClientParam PHONETIC
      Fluent Client search parameter constant for phonetic

      Description: Multiple Resources: [Patient](patient.html): A portion of either family or given name using some kind of phonetic matching algorithm [Person](person.html): A portion of name using some kind of phonetic matching algorithm [Practitioner](practitioner.html): A portion of either family or given name using some kind of phonetic matching algorithm [RelatedPerson](relatedperson.html): A portion of name using some kind of phonetic matching algorithm
      Type: string
      Path: Patient.name | Person.name | Practitioner.name | RelatedPerson.name

    • SP_TELECOM

      public static final String SP_TELECOM
      Search parameter: telecom

      Description: Multiple Resources: [Patient](patient.html): The value in any kind of telecom details of the patient [Person](person.html): The value in any kind of contact [Practitioner](practitioner.html): The value in any kind of contact [PractitionerRole](practitionerrole.html): The value in any kind of contact [RelatedPerson](relatedperson.html): The value in any kind of contact
      Type: token
      Path: Patient.telecom | Person.telecom | Practitioner.telecom | PractitionerRole.contact.telecom | RelatedPerson.telecom

      See Also:

    • TELECOM

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam TELECOM
      Fluent Client search parameter constant for telecom

      Description: Multiple Resources: [Patient](patient.html): The value in any kind of telecom details of the patient [Person](person.html): The value in any kind of contact [Practitioner](practitioner.html): The value in any kind of contact [PractitionerRole](practitionerrole.html): The value in any kind of contact [RelatedPerson](relatedperson.html): The value in any kind of contact
      Type: token
      Path: Patient.telecom | Person.telecom | Practitioner.telecom | PractitionerRole.contact.telecom | RelatedPerson.telecom

  • Constructor Details

  • Method Details