Login HIEBus™ WebClient

API end point: https://fhir.careevolution.com/Master.Adapter1.WebClient/api/fhir-r4.

Resource Person (R4)

Maps the CareEvolution UserInfo concept

Supported interactions

Search parameters

Name Type Modifiers , prefixes Multiple values Can be chained Description
_count Special eq

The maximum number of resources to return in a result page.
_elements Special eq

Used to request a specific set of elements be returned as part of a resource.
_id Token Yes

Resource id
_summary Special eq

Used to return only a portion of the resouces. Defaults to 'false', which returns the whole resource.
_total Special eq

Use the value 'estimate' to populate the result bundle's 'total' element with an estimate of the matching number of resources.
address String :contains :exact :missing Yes

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
address-city String :contains :exact :missing Yes

A city specified in an address
address-country String :contains :exact :missing Yes

A country specified in an address
address-postalcode String :contains :exact :missing Yes

A postal code specified in an address
address-state String :contains :exact :missing Yes

A state specified in an address
birthdate Date :missing eq ne lt le gt ge sa eb ap

The person's date of birth
gender Token :missing Yes

The gender of the person
identifier Token :missing Yes

A person Identifier
link Reference (Patient) :missing Yes Yes

The patient the Person is about. Functionally identical to the "patient" search parameter.
name String :contains :exact :missing Yes

A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text
relatedpatient Reference (Patient) :missing Yes Yes

The patient the Person is about. Functionally identical to the "patient" search parameter.
telecom Token :missing Yes

The value in any kind of contact

Sorts

Supports multiple sorts

Includes

To FHIR mappings

FHIR CareEvolution
address.city Demographic.Addresses.City
address.country Demographic.Addresses.Country
address.district Demographic.Addresses.County
address.extension('http://careevolution.com/fhirextensions#properties') Demographic.Addresses.Properties
address.line Demographic.Addresses.Street1
Demographic.Addresses.Street2
Demographic.Addresses.Street3
address.period Demographic.Addresses.ActiveFrom
Demographic.Addresses.ActiveTo
address.postalCode Demographic.Addresses.PostalCode
address.state Demographic.Addresses.State
address.use
Bindings:  valueset-address-use 		Demographic.Addresses.Type
Domain: AddressType
birthDate Demographic.DOB
extension('http://careevolution.com/fhirextensions#person-group') GroupID
extension('http://careevolution.com/fhirextensions#person-institutions') Institutions
extension('http://careevolution.com/fhirextensions#person-lastLogin') LastLogin
extension('http://careevolution.com/fhirextensions#person-relatedPatients') RelatedPatients
extension('http://careevolution.com/fhirextensions#person-roles') Roles
extension('http://careevolution.com/fhirextensions#person-suspendedDate') SuspendedDate
gender
Bindings:  valueset-administrative-gender 		Demographic.Gender
Domain: Gender
identifier UserName
Demographic.Identifiers
link Patient IDs
name.family Demographic.Names.LastName
name.given Demographic.Names.FirstName
Demographic.Names.MiddleName
name.prefix Demographic.Names.Title
name.suffix Demographic.Names.Suffix
name.use
Bindings:  valueset-name-use 		Demographic.Names.Type
Domain: NameType
photo Demographic picture
telecom.rank Demographic.ContactInfos.ContactInfoUseCode
Domain: ContactInfoUseCode
telecom.system
Bindings:  valueset-contact-point-system 		Demographic.ContactInfos.ContactInfoType
Domain: ContactInfoType
Demographic.ContactInfos.ContactInfoUseCode
Domain: ContactInfoUseCode
telecom.use
Bindings:  valueset-contact-point-use 		Demographic.ContactInfos.ContactInfoType
Domain: ContactInfoType
Demographic.ContactInfos.ContactInfoUseCode
Domain: ContactInfoUseCode
telecom.value Demographic.ContactInfos.Info
Demographic.ContactInfos.CountryCode
Demographic.ContactInfos.AreaCode
Demographic.ContactInfos.LocalNumber
Demographic.ContactInfos.Extension

From FHIR mappings

FHIR CareEvolution
address.city Demographic.Addresses.City
address.country Demographic.Addresses.Country
address.district Demographic.Addresses.County
address.extension('http://careevolution.com/fhirextensions#properties') Demographic.Addresses.Properties
address.line Demographic.Addresses.Street1
Demographic.Addresses.Street2
Demographic.Addresses.Street3
address.period Demographic.Addresses.ActiveFrom
Demographic.Addresses.ActiveTo
address.postalCode Demographic.Addresses.PostalCode
address.state Demographic.Addresses.State
address.use
Bindings:  valueset-address-use 		Demographic.Addresses.Type
Domain: AddressType
birthDate Demographic.DOB
extension('http://careevolution.com/fhirextensions#person-lastLogin') LastLogin
extension('http://careevolution.com/fhirextensions#person-suspendedDate') SuspendedDate
gender
Bindings:  valueset-administrative-gender 		Demographic.Gender
Domain: Gender
name.family Demographic.Names.LastName
name.given Demographic.Names.FirstName
Demographic.Names.MiddleName
name.prefix Demographic.Names.Title
name.suffix Demographic.Names.Suffix
name.text Demographic.Names.LastName
Demographic.Names.MiddleName
Demographic.Names.FirstName
name.use
Bindings:  valueset-name-use 		Demographic.Names.Type
Domain: NameType
telecom.system
Bindings:  valueset-contact-point-system 		Demographic.ContactInfos.ContactInfoType
Domain: ContactInfoType
Demographic.ContactInfos.ContactInfoUseCode
Domain: ContactInfoUseCode
telecom.use
Bindings:  valueset-contact-point-use 		Demographic.ContactInfos.ContactInfoType
Domain: ContactInfoType
Demographic.ContactInfos.ContactInfoUseCode
Domain: ContactInfoUseCode
telecom.value Demographic.ContactInfos.Info