Login HIEBus™ WebClient

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

Resource Immunization (R4)

Maps CareEvolution MedicationAdministration concepts that are immunization, i.e. those with an AdminMethod term code equal to 'Immunization Tag'
The mapping includes also the MedicationProfile concept associated with each MedicationAdministration.
The mapping does not include any claim service or medication because the immunization service codes term subset is not defined in the configuration

Supported interactions

Search parameters

Name Type Modifiers , prefixes Multiple values Can be chained Description
_id Token Yes

Resource id
_lastUpdated Date lt le gt ge

When the resource last changed
_source Uri :missing Yes

Where the resource comes from
claim Reference (Claim) :missing Yes Yes

Searches for immunizations by their associated claim
date Date :missing eq ne lt le gt ge sa eb ap

Vaccination (non)-Administration Date
encounter Reference (Encounter) :missing Yes Yes

Searches for immunizations by their associated encounter
explanation-of-benefit Reference (ExplanationOfBenefit) :missing Yes Yes

Searches for immunizations by their associated explanation of benefit
lot-number String :contains :exact :missing Yes

Vaccine Lot Number
patient Reference (Patient) :missing Yes Yes

The patient the Immunization is about
performer Reference (Practitioner) :missing Yes Yes

The practitioner or organization who played a role in the vaccination
provenance-agent Reference (Organization) :missing Yes Yes

Search by provenance, specified by its author (aka originator) Organization
reason-code Token :not :in :not-in :missing Yes

Reason why the vaccine was administered
status Token :missing Yes

Immunization event status
vaccine-code Token :not :in :not-in :missing Yes

Vaccine Product Administered

Sorts

Supports multiple sorts

Includes

Operations

To FHIR mappings

CareEvolution FHIR
Claim.EncounterID encounter
Claim.ID extension('http://careevolution.com/fhirextensions#immunization-claimReference')
extension('http://careevolution.com/fhirextensions#immunization-eobReference')
Claim.PatientID patient
ClaimService.CaregiverRelationships.CaregiverID performer.actor
ClaimService.CaregiverRelationships.RelationshipType
Domain: CaregiverRelationshipType 		performer.function
ClaimService.ClaimID status
Bindings:  valueset-immunization-status
ClaimService.Comment note
ClaimService.ServiceCode
Domain: ServiceCode 		vaccineCode
Bindings:  http://www.ada.org/cdt  http://snomed.info/sct  https://www.cms.gov/Medicare/Coding/HCPCSReleaseCodeSets  http://www.cms.gov/Medicare/Coding/ICD10  http://hl7.org/fhir/sid/icd-9-cm
ClaimService.StartDate occurrence
ClaimService.Status
Domain: ClaimServiceStatus 		status
Bindings:  valueset-immunization-status
Medication.ClaimID status
Bindings:  valueset-immunization-status
extension('http://careevolution.com/fhirextensions#immunization-claimReference')
extension('http://careevolution.com/fhirextensions#immunization-eobReference')
Medication.Comment note
Medication.DataSource extension('http://careevolution.com/fhirextensions#dataSource')
Medication.Date occurrence
Medication.Dose doseQuantity
Bindings:  http://unitsofmeasure.org
Medication.EncounterID encounter
Medication.FilledByID performer.actor
Medication.PatientID patient
Medication.Status
Domain: MedicationStatus 		status
Bindings:  valueset-immunization-status
Medication.Term
Domain: MedicationType 		vaccineCode
Bindings:  http://hl7.org/fhir/sid/cvx  http://hl7.org/fhir/sid/ndc  http://www.nlm.nih.gov/research/umls/rxnorm  http://snomed.info/sct
doseQuantity
Bindings:  http://unitsofmeasure.org
Medication.Units
Domain: MedicationUnits 		doseQuantity
Bindings:  http://unitsofmeasure.org
MedicationAdministration.CaregiverID performer.actor
MedicationAdministration.Comment note
MedicationAdministration.Dose doseQuantity
Bindings:  http://unitsofmeasure.org
MedicationAdministration.DoseStartTime occurrence
MedicationAdministration.DoseUnits
Domain: MedicationAdministrationDoseUnits 		doseQuantity
Bindings:  http://unitsofmeasure.org
MedicationAdministration.EncounterID encounter
MedicationAdministration.LotNumber lotNumber
MedicationAdministration.Manufacturer manufacturer
MedicationAdministration.PatientID patient
MedicationAdministration.PropertyBag primarySource
MedicationAdministration.ReasonGiven
Domain: MedicationAdministrationReasonGiven 		reasonCode
MedicationAdministration.ReasonNotGiven
Domain: MedicationAdministrationReasonNotGiven 		statusReason
MedicationAdministration.Route
Domain: MedicationAdministrationRoute 		route
MedicationAdministration.RouteAlternateTerms
Domain: MedicationAdministrationRoute 		route
MedicationAdministration.RouteText route
MedicationAdministration.ScheduledTime occurrence
MedicationAdministration.Site
Domain: MedicationAdministrationSite 		site
MedicationAdministration.Status
Domain: MedicationAdministrationStatus 		status
Bindings:  valueset-immunization-status
MedicationProfile.AdminSite
Domain: MedicationProfileAdminSite 		site
MedicationProfile.DataSource extension('http://careevolution.com/fhirextensions#dataSource')
MedicationProfile.Identifier identifier
MedicationProfile.Medication
Domain: MedicationProfileMedication 		vaccineCode
Bindings:  http://hl7.org/fhir/sid/cvx  http://hl7.org/fhir/sid/ndc  http://www.nlm.nih.gov/research/umls/rxnorm  http://snomed.info/sct
MedicationProfile.MedicationAlternateTerms
Domain: MedicationProfileMedication 		vaccineCode
Bindings:  http://hl7.org/fhir/sid/cvx  http://hl7.org/fhir/sid/ndc  http://www.nlm.nih.gov/research/umls/rxnorm  http://snomed.info/sct
MedicationProfile.MedicationText vaccineCode
Bindings:  http://hl7.org/fhir/sid/cvx  http://hl7.org/fhir/sid/ndc  http://www.nlm.nih.gov/research/umls/rxnorm  http://snomed.info/sct
MedicationProfile.Route
Domain: MedicationProfileRoute 		route
MedicationProfile.RouteAlternateTerms
Domain: MedicationProfileRoute 		route
MedicationProfile.RouteText route
Order.FillerOrderNumber primarySource
Order.PlacerOrderNumber primarySource

From FHIR mappings

CareEvolution FHIR
Claim.EncounterID encounter
Claim.ID extension('http://careevolution.com/fhirextensions#immunization-claimReference')
extension('http://careevolution.com/fhirextensions#immunization-eobReference')
Claim.PatientID patient
ClaimService.CaregiverRelationships.CaregiverID performer.actor
ClaimService.CaregiverRelationships.RelationshipType
Domain: CaregiverRelationshipType 		performer.function
ClaimService.Comment note
ClaimService.ServiceCode
Domain: ServiceCode 		vaccineCode
Bindings:  http://www.ada.org/cdt  http://snomed.info/sct  https://www.cms.gov/Medicare/Coding/HCPCSReleaseCodeSets  http://www.cms.gov/Medicare/Coding/ICD10  http://hl7.org/fhir/sid/icd-9-cm
ClaimService.StartDate occurrence
ClaimService.Status
Domain: ClaimServiceStatus 		status
Bindings:  valueset-immunization-status
Medication.ClaimID extension('http://careevolution.com/fhirextensions#immunization-claimReference')
extension('http://careevolution.com/fhirextensions#immunization-eobReference')
Medication.Comment note
Medication.DataSource extension('http://careevolution.com/fhirextensions#dataSource')
Medication.Date occurrence
Medication.Dose doseQuantity
Bindings:  http://unitsofmeasure.org
Medication.EncounterID encounter
Medication.FilledByID performer.actor
Medication.PatientID patient
Medication.Status
Domain: MedicationStatus 		status
Bindings:  valueset-immunization-status
Medication.Term
Domain: MedicationType 		vaccineCode
Bindings:  http://hl7.org/fhir/sid/cvx  http://hl7.org/fhir/sid/ndc  http://www.nlm.nih.gov/research/umls/rxnorm  http://snomed.info/sct
Medication.Units
Domain: MedicationUnits 		doseQuantity
Bindings:  http://unitsofmeasure.org
MedicationAdministration.CaregiverID performer.actor
MedicationAdministration.Comment note
MedicationAdministration.Dose doseQuantity
Bindings:  http://unitsofmeasure.org
MedicationAdministration.DoseStartTime occurrence
MedicationAdministration.DoseUnits
Domain: MedicationAdministrationDoseUnits 		doseQuantity
Bindings:  http://unitsofmeasure.org
MedicationAdministration.EncounterID encounter
MedicationAdministration.LotNumber lotNumber
MedicationAdministration.Manufacturer manufacturer
MedicationAdministration.PatientID patient
MedicationAdministration.PropertyBag primarySource
MedicationAdministration.ReasonGiven
Domain: MedicationAdministrationReasonGiven 		reasonCode
MedicationAdministration.ReasonNotGiven
Domain: MedicationAdministrationReasonNotGiven 		statusReason
MedicationAdministration.Route
Domain: MedicationAdministrationRoute 		route
MedicationAdministration.RouteAlternateTerms
Domain: MedicationAdministrationRoute 		route
MedicationAdministration.RouteText route
MedicationAdministration.ScheduledTime occurrence
MedicationAdministration.Site
Domain: MedicationAdministrationSite 		site
MedicationAdministration.Status
Domain: MedicationAdministrationStatus 		status
Bindings:  valueset-immunization-status
MedicationProfile.AdminSite
Domain: MedicationProfileAdminSite 		site
MedicationProfile.DataSource extension('http://careevolution.com/fhirextensions#dataSource')
MedicationProfile.DoseUnits
Domain: MedicationProfileDoseUnits 		doseQuantity
Bindings:  http://unitsofmeasure.org
MedicationProfile.Identifier identifier
id
MedicationProfile.MaxDose doseQuantity
Bindings:  http://unitsofmeasure.org
MedicationProfile.Medication
Domain: MedicationProfileMedication 		vaccineCode
Bindings:  http://hl7.org/fhir/sid/cvx  http://hl7.org/fhir/sid/ndc  http://www.nlm.nih.gov/research/umls/rxnorm  http://snomed.info/sct
MedicationProfile.MedicationAlternateTerms
Domain: MedicationProfileMedication 		vaccineCode
Bindings:  http://hl7.org/fhir/sid/cvx  http://hl7.org/fhir/sid/ndc  http://www.nlm.nih.gov/research/umls/rxnorm  http://snomed.info/sct
MedicationProfile.MedicationText vaccineCode
Bindings:  http://hl7.org/fhir/sid/cvx  http://hl7.org/fhir/sid/ndc  http://www.nlm.nih.gov/research/umls/rxnorm  http://snomed.info/sct
MedicationProfile.MinDose doseQuantity
Bindings:  http://unitsofmeasure.org
MedicationProfile.Route
Domain: MedicationProfileRoute 		route
MedicationProfile.RouteAlternateTerms
Domain: MedicationProfileRoute 		route
MedicationProfile.RouteText route