R6 Ballot (1st Draft)

This page is part of the FHIR Specification v6.0.0-ballot1: Release 6 Ballot (1st Draft) (see Ballot Notes). The current version is 5.0.0. For a full list of available versions, see the Directory of published versions

8.2.13 Resource RelatedPerson - Search Parameters

Patient Administration icon Work GroupMaturity Level: N/A  Trial UseSecurity 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 active

Parameter active:token

Indicates if the related person record is active

ResourceRelatedPerson
ExpressionRelatedPerson.active
Processing ModeNormal
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-address
This search parameter is part of the common search parameter individual-address

8.2.15 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

ResourceRelatedPerson
ExpressionRelatedPerson.address
Processing ModeNormal
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-address-city
This search parameter is part of the common search parameter individual-address-city

8.2.16 address-city

Parameter address-city:string

RelatedPerson: A city specified in an address

ResourceRelatedPerson
ExpressionRelatedPerson.address.city
Processing ModeNormal
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-address-country
This search parameter is part of the common search parameter individual-address-country

8.2.17 address-country

Parameter address-country:string

RelatedPerson: A country specified in an address

ResourceRelatedPerson
ExpressionRelatedPerson.address.country
Processing ModeNormal
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-address-postalcode
This search parameter is part of the common search parameter individual-address-postalcode

8.2.18 address-postalcode

Parameter address-postalcode:string

RelatedPerson: A postal code specified in an address

ResourceRelatedPerson
ExpressionRelatedPerson.address.postalCode
Processing ModeNormal
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-address-state
This search parameter is part of the common search parameter individual-address-state

8.2.19 address-state

Parameter address-state:string

RelatedPerson: A state specified in an address

ResourceRelatedPerson
ExpressionRelatedPerson.address.state
Processing ModeNormal
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-address-use
This search parameter is part of the common search parameter individual-address-use

8.2.20 address-use

Parameter address-use:token

RelatedPerson: A use code specified in an address

ResourceRelatedPerson
ExpressionRelatedPerson.address.use
Processing ModeNormal
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-birthdate
This search parameter is part of the common search parameter individual-birthdate

8.2.21 birthdate

Parameter birthdate:date

RelatedPerson: The Related Person's date of birth

ResourceRelatedPerson
ExpressionRelatedPerson.birthDate
Processing ModeNormal
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
ComparatorsAllowed: 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 email

Parameter email:token

RelatedPerson: A value in an email contact

ResourceRelatedPerson
ExpressionRelatedPerson.telecom.where(system='email')
Processing ModeNormal
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/RelatedPerson-family

8.2.23 family

Parameter family:string

A portion of the family name of the related person

ResourceRelatedPerson
ExpressionRelatedPerson.name.family
Processing ModeNormal
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-gender
This search parameter is part of the common search parameter individual-gender

8.2.24 gender

Parameter gender:token

RelatedPerson: Gender of the related person

ResourceRelatedPerson
ExpressionRelatedPerson.gender
Processing ModeNormal
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/RelatedPerson-given

8.2.25 given

Parameter given:string

A portion of the given name of the related person

ResourceRelatedPerson
ExpressionRelatedPerson.name.given
Processing ModeNormal
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/clinical-identifier
This search parameter is part of the common search parameter clinical-identifier

8.2.26 identifier

Parameter identifier:token

RelatedPerson: An Identifier of the RelatedPerson

ResourceRelatedPerson
ExpressionRelatedPerson.identifier
Processing ModeNormal
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/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
Processing ModeNormal
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/clinical-patient
This search parameter is part of the common search parameter clinical-patient

8.2.28 patient

Parameter patient:reference

RelatedPerson: The patient this related person is related to

ResourceRelatedPerson
ExpressionRelatedPerson.patient
Processing ModeNormal
Target ResourcesPatient
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-phone
This search parameter is part of the common search parameter individual-phone

8.2.29 phone

Parameter phone:token

RelatedPerson: A value in a phone contact

ResourceRelatedPerson
ExpressionRelatedPerson.telecom.where(system='phone')
Processing ModeNormal
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-phonetic
This search parameter is part of the common search parameter individual-phonetic

8.2.30 phonetic

Parameter phonetic:string

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

ResourceRelatedPerson
ExpressionRelatedPerson.name
Processing ModePhonetic
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/RelatedPerson-relationship

8.2.31 relationship

Parameter relationship:token

The relationship between the patient and the relatedperson

ResourceRelatedPerson
ExpressionRelatedPerson.relationship
Processing ModeNormal
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

8.2.32 telecom

Parameter telecom:token

RelatedPerson: The value in any kind of contact

ResourceRelatedPerson
ExpressionRelatedPerson.telecom
Processing ModeNormal
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