API end point: https://nchess.careevolution.com/WebClient/api/Clover-PostData.

Resource Patient (STU3)

Maps the CareEvolution Patient concept, merging all the patients in the same RecordGroup. The FHIR id is RecordGroup.PersonID

• Supported interactions
• Search parameters
• Sorts
• Includes
• Operations
• To FHIR mappings
• From FHIR mappings

Supported interactions

• read
• search
• create
• update
• delete

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
_source	Uri	:missing	Yes		Where the resource comes from
_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, 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 postalCode specified in an address
address-state	String	:contains :exact :missing	Yes		A state specified in an address
age	Number	:missing eq lt le gt ge			Searches for patients based on age as calculated based on current date and date of birth. Deceased patients are excluded from the search.
birthdate	Date	:missing eq ne lt le gt ge sa eb ap			The patient's date of birth
ethnicity	Token	:not :in :not-in :missing	Yes		Returns patients with an ethnicity extension matching the specified code.
family	String	:contains :exact :missing	Yes		A portion of the family name of the patient
gender	Token	:missing	Yes		Gender of the patient
given	String	:contains :exact :missing	Yes		A portion of the given name of the patient
identifier	Token	:missing	Yes		A patient identifier
language	Token	:not :in :not-in :missing	Yes		Language code (irrespective of use value)
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
provenance-agent	Reference (Organization)	:missing	Yes	Yes	Search by provenance, specified by its author (aka originator) Organization
race	Token	:not :in :not-in :missing	Yes		Returns patients with a race extension matching the specified code.
telecom	Token	:missing	Yes		The value in any kind of telecom details of the patient
us-core-ethnicity	Token	:not :in :not-in :missing	Yes		See here
us-core-race	Token	:not :in :not-in :missing	Yes		See here

Sorts

• _id
• address
• address-city
• address-country
• address-postalcode
• address-state
• birthdate
• family
• given
• name
• telecom

Supports multiple sorts

Includes

• provenance-agent
• AllergyIntolerance:patient
• AuditEvent:patient
• CarePlan:patient
• CarePlan:subject
• CareTeam:patient
• CareTeam:subject
• Claim:patient
• Condition:patient
• Condition:subject
• Coverage:beneficiary
• Coverage:patient
• DiagnosticReport:patient
• DiagnosticReport:subject
• DocumentReference:patient
• DocumentReference:subject
• Encounter:patient
• Encounter:subject
• ExplanationOfBenefit:patient
• Goal:patient
• Goal:subject
• Group:member
• Immunization:patient
• MedicationAdministration:patient
• MedicationAdministration:subject
• MedicationDispense:patient
• MedicationDispense:subject
• MedicationRequest:patient
• MedicationRequest:subject
• MedicationStatement:patient
• MedicationStatement:subject
• Observation:patient
• Observation:subject
• Person:link
• Person:relatedpatient
• Procedure:patient
• Procedure:subject
• ProcedureRequest:patient
• ProcedureRequest:subject
• Provenance:target
• ReferralRequest:patient
• ReferralRequest:subject
• RelatedPerson:patient
• Specimen:patient
• Specimen:subject
• Task:patient
• Task:subject

Operations

• validate - Validate a resource
• everything - Fetch Patient Record
• export

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
communication	Demographic.PreferredLanguage Domain: PreferredLanguage
	Demographic.PreferredLanguageAlternate Domain: PreferredLanguage
	Demographic.PreferredLanguageText
deceased	Demographic.Deceased
	Demographic.DeceasedDate
extension('http://careevolution.com/fhirextensions#patientInstitutions')	PatientInstitutions
extension('http://hl7.org/fhir/StructureDefinition/patient-religion') Bindings:  http://hl7.org/fhir/v3/ReligiousAffiliation	Demographic.Religion Domain: Religion
	Demographic.ReligionAlternate Domain: Religion
	Demographic.ReligionText
extension('http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex') Bindings:  ValueSet-birthsex	Demographic.BirthSex Domain: Gender
extension('http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity')	Demographic.Ethnicity Domain: Ethnicity
	Demographic.EthnicityAlternate Domain: Ethnicity
	Demographic.EthnicityText
extension('http://hl7.org/fhir/us/core/StructureDefinition/us-core-race')	Demographic.Race Domain: Race
	Demographic.RaceAlternate Domain: Race
	Demographic.RaceText
gender Bindings:  valueset-administrative-gender	Demographic.Gender Domain: Gender
identifier	Identifier
	RecordAuthority
	Demographic.Identifiers
	id
maritalStatus Bindings:  http://hl7.org/fhir/v3/NullFlavor  http://hl7.org/fhir/v3/MaritalStatus	Demographic.MaritalStatus Domain: MaritalStatus
	Demographic.MaritalStatusAlternate Domain: MaritalStatus
	Demographic.MaritalStatusText
meta.security	AccessPolicyID
multipleBirth	Demographic.MultipleBirth
	Demographic.MultipleBirthOrder
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 pictures
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
communication	Demographic.PreferredLanguage Domain: PreferredLanguage
	Demographic.PreferredLanguageAlternate Domain: PreferredLanguage
	Demographic.PreferredLanguageText
deceased	Demographic.Deceased
	Demographic.DeceasedDate
extension('http://hl7.org/fhir/StructureDefinition/patient-religion') Bindings:  http://hl7.org/fhir/v3/ReligiousAffiliation	Demographic.Religion Domain: Religion
	Demographic.ReligionAlternate Domain: Religion
	Demographic.ReligionText
extension('http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex') Bindings:  ValueSet-birthsex	Demographic.BirthSex Domain: Gender
extension('http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity')	Demographic.Ethnicity Domain: Ethnicity
	Demographic.EthnicityAlternate Domain: Ethnicity
	Demographic.EthnicityText
extension('http://hl7.org/fhir/us/core/StructureDefinition/us-core-race')	Demographic.Race Domain: Race
	Demographic.RaceAlternate Domain: Race
	Demographic.RaceText
gender Bindings:  valueset-administrative-gender	Demographic.Gender Domain: Gender
id	Demographic.Identifiers
identifier	Identifier
	RecordAuthority
	Demographic.Identifiers
maritalStatus Bindings:  http://hl7.org/fhir/v3/NullFlavor  http://hl7.org/fhir/v3/MaritalStatus	Demographic.MaritalStatus Domain: MaritalStatus
	Demographic.MaritalStatusAlternate Domain: MaritalStatus
	Demographic.MaritalStatusText
multipleBirth	Demographic.MultipleBirth
	Demographic.MultipleBirthOrder
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
photo	Demographic pictures
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

---