Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

8.2.12 Resource RelatedPerson - Search Parameters

Patient Administration Work GroupMaturity Level: N/AStandards Status: InformativeSecurity Category: Patient Compartments: Patient, RelatedPerson

Search Parameter Registry for the relatedperson resource

8.2.13 Search Parameters

Search parameter list for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

http://hl7.org/fhir/SearchParameter/RelatedPerson-active

8.2.14 active

Parameter active:token

Indicates if the related person record is active

ResourceRelatedPerson
ExpressionRelatedPerson.active
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/RelatedPerson-address

8.2.15 address

Parameter address:string

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

Resources
ExpressionRelatedPerson.address
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/RelatedPerson-address-city

8.2.16 address-city

Parameter address-city:string

A city specified in an address

Resources
ExpressionRelatedPerson.address.city
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/RelatedPerson-address-country

8.2.17 address-country

Parameter address-country:string

A country specified in an address

Resources
ExpressionRelatedPerson.address.country
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/RelatedPerson-address-postalcode

8.2.18 address-postalcode

Parameter address-postalcode:string

A postal code specified in an address

Resources
ExpressionRelatedPerson.address.postalCode
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/RelatedPerson-address-state

8.2.19 address-state

Parameter address-state:string

A state specified in an address

Resources
ExpressionRelatedPerson.address.state
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/RelatedPerson-address-use

8.2.20 address-use

Parameter address-use:token

A use code specified in an address

Resources
ExpressionRelatedPerson.address.use
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/RelatedPerson-birthdate

8.2.21 birthdate

Parameter birthdate:date

The Related Person's date of birth

Resources
ExpressionRelatedPerson.birthDate
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/RelatedPerson-email

8.2.22 email

Parameter email:token

A value in an email contact

Resources
ExpressionRelatedPerson.telecom.where(system='email')
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/RelatedPerson-family

8.2.23 family

Parameter family:string

A portion of the family name of the related person

ResourceRelatedPerson
ExpressionRelatedPerson.name.family
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/RelatedPerson-gender

8.2.24 gender

Parameter gender:token

Gender of the related person

Resources
ExpressionRelatedPerson.gender
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/RelatedPerson-given

8.2.25 given

Parameter given:string

A portion of the given name of the related person

ResourceRelatedPerson
ExpressionRelatedPerson.name.given
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/RelatedPerson-identifier

8.2.26 identifier

Parameter identifier:token

An Identifier of the RelatedPerson

ResourceRelatedPerson
ExpressionRelatedPerson.identifier
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/RelatedPerson-name

8.2.27 name

Parameter name:string

A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text

ResourceRelatedPerson
ExpressionRelatedPerson.name
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/RelatedPerson-patient

8.2.28 patient

Parameter patient:reference

The patient this related person is related to

ResourceRelatedPerson
ExpressionRelatedPerson.patient
Target ResourcesPatient
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/RelatedPerson-phone

8.2.29 phone

Parameter phone:token

A value in a phone contact

Resources
ExpressionRelatedPerson.telecom.where(system='phone')
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/RelatedPerson-phonetic

8.2.30 phonetic

Parameter phonetic:string

A portion of name using some kind of phonetic matching algorithm

Resources
ExpressionRelatedPerson.name
UsagePhonetic
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/RelatedPerson-relationship

8.2.31 relationship

Parameter relationship:token

The relationship between the patient and the relatedperson

ResourceRelatedPerson
ExpressionRelatedPerson.relationship
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/RelatedPerson-telecom

8.2.32 telecom

Parameter telecom:token

The value in any kind of contact

Resources
ExpressionRelatedPerson.telecom
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values