--- type: "search-params" title: "RelatedPerson Search Parameters" resource: "RelatedPerson" --- # RelatedPerson Search Parameters ## active **Description:** Indicates if the related person record is active **Type:** token **Expression:** RelatedPerson.active **Path:** RelatedPerson.active **Standards Status:** normative **URL:** http://hl7.org/fhir/build/SearchParameter/RelatedPerson-active ## address **Description:** 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 **Expression:** RelatedPerson.address **Path:** RelatedPerson.address **Standards Status:** normative **URL:** http://hl7.org/fhir/build/SearchParameter/RelatedPerson-address ## address-city **Description:** A city specified in an address **Type:** string **Expression:** RelatedPerson.address.city **Path:** RelatedPerson.address.city **Standards Status:** normative **URL:** http://hl7.org/fhir/build/SearchParameter/RelatedPerson-address-city ## address-country **Description:** A country specified in an address **Type:** string **Expression:** RelatedPerson.address.country **Path:** RelatedPerson.address.country **Standards Status:** normative **URL:** http://hl7.org/fhir/build/SearchParameter/RelatedPerson-address-country ## address-postalcode **Description:** A postal code specified in an address **Type:** string **Expression:** RelatedPerson.address.postalCode **Path:** RelatedPerson.address.postalCode **Standards Status:** normative **URL:** http://hl7.org/fhir/build/SearchParameter/RelatedPerson-address-postalcode ## address-state **Description:** A state specified in an address **Type:** string **Expression:** RelatedPerson.address.state **Path:** RelatedPerson.address.state **Standards Status:** normative **URL:** http://hl7.org/fhir/build/SearchParameter/RelatedPerson-address-state ## address-use **Description:** A use code specified in an address **Type:** token **Expression:** RelatedPerson.address.use **Path:** RelatedPerson.address.use **Standards Status:** normative **URL:** http://hl7.org/fhir/build/SearchParameter/RelatedPerson-address-use ## birthdate **Description:** The Related Person's date of birth **Type:** date **Expression:** RelatedPerson.birthDate **Path:** RelatedPerson.birthDate **Standards Status:** normative **URL:** http://hl7.org/fhir/build/SearchParameter/RelatedPerson-birthdate ## email **Description:** A value in an email contact **Type:** token **Expression:** RelatedPerson.telecom.where(system='email') **Path:** RelatedPerson.telecom(system=email) **Standards Status:** normative **URL:** http://hl7.org/fhir/build/SearchParameter/RelatedPerson-email ## gender **Description:** Gender of the related person **Type:** token **Expression:** RelatedPerson.gender **Path:** RelatedPerson.gender **Standards Status:** normative **URL:** http://hl7.org/fhir/build/SearchParameter/RelatedPerson-gender ## identifier **Description:** An Identifier of the RelatedPerson **Type:** token **Expression:** RelatedPerson.identifier **Path:** RelatedPerson.identifier **Standards Status:** normative **URL:** http://hl7.org/fhir/build/SearchParameter/RelatedPerson-identifier ## 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 **Expression:** RelatedPerson.name **Path:** RelatedPerson.name **Standards Status:** normative **URL:** http://hl7.org/fhir/build/SearchParameter/RelatedPerson-name ## family **Description:** A portion of the family name of the related person **Type:** string **Expression:** RelatedPerson.name.family **Path:** RelatedPerson.name.family **Standards Status:** normative **URL:** http://hl7.org/fhir/build/SearchParameter/RelatedPerson-family ## given **Description:** A portion of the given name of the related person **Type:** string **Expression:** RelatedPerson.name.given **Path:** RelatedPerson.name.given **Standards Status:** normative **URL:** http://hl7.org/fhir/build/SearchParameter/RelatedPerson-given ## patient **Description:** The patient this related person is related to **Type:** reference **Expression:** RelatedPerson.patient **Path:** RelatedPerson.patient **Standards Status:** normative **URL:** http://hl7.org/fhir/build/SearchParameter/RelatedPerson-patient ## phone **Description:** A value in a phone contact **Type:** token **Expression:** RelatedPerson.telecom.where(system='phone') **Path:** RelatedPerson.telecom(system=phone) **Standards Status:** normative **URL:** http://hl7.org/fhir/build/SearchParameter/RelatedPerson-phone ## phonetic **Description:** A portion of name using some kind of phonetic matching algorithm **Type:** string **Expression:** RelatedPerson.name **Path:** RelatedPerson.name **Standards Status:** normative **URL:** http://hl7.org/fhir/build/SearchParameter/RelatedPerson-phonetic ## relationship **Description:** The personal relationship between the patient and the relatedperson **Type:** token **Expression:** RelatedPerson.relationship **Path:** RelatedPerson.relationship **Standards Status:** normative **URL:** http://hl7.org/fhir/build/SearchParameter/RelatedPerson-relationship ## role **Description:** The functional relationship between the patient and the relatedperson **Type:** token **Expression:** RelatedPerson.relationship **Path:** RelatedPerson.role **Standards Status:** normative **URL:** http://hl7.org/fhir/build/SearchParameter/RelatedPerson-role ## telecom **Description:** The value in any kind of contact **Type:** token **Expression:** RelatedPerson.telecom **Path:** RelatedPerson.telecom **Standards Status:** normative **URL:** http://hl7.org/fhir/build/SearchParameter/RelatedPerson-telecom