Tutorials

Use Cases

Interface

Resources

Operations

Examples & Testing

Endpoints

Related Person

4.0.1. (R4) 3.0.1. (STU3) 1.0.2 (DSTU2)

A Related Person resource can represent anyone involved in the care of a patient who has no formal responsibility (e.g., a home caregiver or family member).

Sample Query

Find relations for a particular patient:

https://fhir.careevolution.com/Master.Adapter1.WebClient/api/fhir/RelatedPerson?patient=f4968df0-3121-e611-8128-0a69c1b3225b

Overview

See the FHIR documentation for more information about Related Person resources.

Mapped Concepts in HIEBus

  • PatientAssociatedParty

Supported Interactions

Related Person resources support the following interactions.

Search Parameters

When searching for Related Person resources, the following search parameters are supported.

Name Type Prefixes
Modifiers 		Can be Chained? Description
_id Token Resource id.
_lastUpdated Date lt  le  gt  ge  When the resource last changed.
address String :contains  :exact  :missing  An address in any kind of address/part.
address-city String :contains  :exact  :missing  A city specified in an address.
address-country String :contains  :exact  :missing  A country specified in an address.
address-postalcode String :contains  :exact  :missing  A postal code specified in an address.
address-state String :contains  :exact  :missing  A state specified in an address.
birthdate Date ne  lt  le  gt  ge  sa  eb  ap  :missing  The Related Person's date of birth.
gender Token :missing  Gender of the person.
name String :contains  :exact  :missing  A portion of name in any name part.
patient Reference :missing  yes The patient this person is related to.
telecom Token :missing  The value in any kind of contact.

Sortable Parameters

When searching Related Person resources, it is possible to sort the returned values by the following search parameters.

  • name
  • address
  • address-city
  • address-country
  • address-postalcode
  • address-state
  • telecom
  • _id

Only one sort parameter may be specified.

Supported Includes

When searching Related Person resources, it is possible to include the resources referenced by the following field names.

  • Patient

Supported Operations

Related Person supports the following extended operations.

Back to Resources

Have questions about the HIEBus FHIR interface? Contact us at fhir@careevolution.com.

Terms of Use

© 2023 CareEvolution, LLC