Release 5 R6 Ballot (2nd Draft)

This page is part of the FHIR Specification (v5.0.0: R5 - STU v6.0.0-ballot2: Release 6 Ballot (2nd Draft) (see Ballot Notes ). This is the The current published version in it's permanent home (it will always be available at this URL). is 5.0.0 . For a full list of available versions, see the Directory of published versions

8.2.13 8.2.12 Resource RelatedPerson - Search Parameters

Patient Administration icon Work Group Maturity Level : N/A   Trial Use Security Category : Patient Compartments : Patient , RelatedPerson

Search parameters for the Resource RelatedPerson - Search Parameters resource. Also check the Extensions registry for search parameters on extensions related to 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 Generated Narrative: SearchParameter RelatedPerson-active

8.2.13 active

Parameter active : token

Indicates if the related person record is active

Resource RelatedPerson
Expression RelatedPerson.active
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/individual-address
This search parameter is part of the common search parameter individual-address

8.2.15 Generated Narrative: SearchParameter individual-address

8.2.14 address

Parameter address : string

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

Resource RelatedPerson
Expression RelatedPerson.address
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/individual-address-city
This search parameter is part of the common search parameter individual-address-city

8.2.16 Generated Narrative: SearchParameter individual-address-city

8.2.15 address-city

Parameter address-city : string

RelatedPerson : A city specified in an address

Resource RelatedPerson
Expression RelatedPerson.address.city
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/individual-address-country
This search parameter is part of the common search parameter individual-address-country

8.2.17 Generated Narrative: SearchParameter individual-address-country

8.2.16 address-country

Parameter address-country : string

RelatedPerson : A country specified in an address

Resource RelatedPerson
Expression RelatedPerson.address.country
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/individual-address-postalcode
This search parameter is part of the common search parameter individual-address-postalcode

8.2.18 Generated Narrative: SearchParameter individual-address-postalcode

8.2.17 address-postalcode

Parameter address-postalcode : string

RelatedPerson : A postal code specified in an address

Resource RelatedPerson
Expression RelatedPerson.address.postalCode
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/individual-address-state
This search parameter is part of the common search parameter individual-address-state

8.2.19 Generated Narrative: SearchParameter individual-address-state

8.2.18 address-state

Parameter address-state : string

RelatedPerson : A state specified in an address

Resource RelatedPerson
Expression RelatedPerson.address.state
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/individual-address-use
This search parameter is part of the common search parameter individual-address-use

8.2.20 Generated Narrative: SearchParameter individual-address-use

8.2.19 address-use

Parameter address-use : token

RelatedPerson : A use code specified in an address

Resource RelatedPerson
Expression RelatedPerson.address.use
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/individual-birthdate
This search parameter is part of the common search parameter individual-birthdate

8.2.21 Generated Narrative: SearchParameter individual-birthdate

8.2.20 birthdate

Parameter birthdate : date

RelatedPerson : The Related Person's date of birth

Resource RelatedPerson
Expression RelatedPerson.birthDate
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
Comparators Allowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/individual-email
This search parameter is part of the common search parameter individual-email

8.2.22 Generated Narrative: SearchParameter individual-email

8.2.21 email

Parameter email : token

RelatedPerson : A value in an email contact

Resource RelatedPerson
Expression RelatedPerson.telecom.where(system='email')
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/RelatedPerson-family

8.2.23 Generated Narrative: SearchParameter RelatedPerson-family

8.2.22 family

Parameter family : string

A portion of the family name of the related person

Resource RelatedPerson
Expression RelatedPerson.name.family
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/individual-gender
This search parameter is part of the common search parameter individual-gender

8.2.24 Generated Narrative: SearchParameter individual-gender

8.2.23 gender

Parameter gender : token

RelatedPerson : Gender of the related person

Resource RelatedPerson
Expression RelatedPerson.gender
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/RelatedPerson-given

8.2.25 Generated Narrative: SearchParameter RelatedPerson-given

8.2.24 given

Parameter given : string

A portion of the given name of the related person

Resource RelatedPerson
Expression RelatedPerson.name.given
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/clinical-identifier
This search parameter is part of the common search parameter clinical-identifier

8.2.26 Generated Narrative: SearchParameter clinical-identifier

8.2.25 identifier

Parameter identifier : token

RelatedPerson : An Identifier of the RelatedPerson

Resource RelatedPerson
Expression RelatedPerson.identifier
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/RelatedPerson-name

8.2.27 Generated Narrative: SearchParameter RelatedPerson-name

8.2.26 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

Resource RelatedPerson
Expression RelatedPerson.name
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/clinical-patient
This search parameter is part of the common search parameter clinical-patient

8.2.28 Generated Narrative: SearchParameter clinical-patient

8.2.27 patient

Parameter patient : reference

RelatedPerson : The patient this related person is related to

Resource RelatedPerson
Expression RelatedPerson.patient
Processing Mode Normal
Target Resources Patient
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/individual-phone
This search parameter is part of the common search parameter individual-phone

8.2.29 Generated Narrative: SearchParameter individual-phone

8.2.28 phone

Parameter phone : token

RelatedPerson : A value in a phone contact

Resource RelatedPerson
Expression RelatedPerson.telecom.where(system='phone')
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/individual-phonetic
This search parameter is part of the common search parameter individual-phonetic

8.2.30 Generated Narrative: SearchParameter individual-phonetic

8.2.29 phonetic

Parameter phonetic : string

RelatedPerson : A portion of name using some kind of phonetic matching algorithm

Resource RelatedPerson
Expression RelatedPerson.name
Processing Mode Phonetic
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/RelatedPerson-relationship

8.2.31 Generated Narrative: SearchParameter RelatedPerson-relationship

8.2.30 relationship

Parameter relationship : token

The personal relationship between the patient and the relatedperson

Resource RelatedPerson
Expression RelatedPerson.relationship
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/RelatedPerson-role

Generated Narrative: SearchParameter RelatedPerson-role

8.2.31 role

Parameter role : token

The functional relationship between the patient and the relatedperson

Resource RelatedPerson
Expression RelatedPerson.relationship
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/individual-telecom
This search parameter is part of the common search parameter individual-telecom

Generated Narrative: SearchParameter individual-telecom

8.2.32 telecom

Parameter telecom : token

RelatedPerson : The value in any kind of contact

Resource RelatedPerson
Expression RelatedPerson.telecom
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true