Encounter type to create an encounter object.
JavaScript
type Encounter = {
identifier?: string; // optional; FHIR encounter id (UUID or non-UUID, at most 36 characters) for ambient interoperability and Patient Summary
practitionerFhirId?: string; // partner-supplied FHIR practitioner id; required for Patient Summary generation and UI (v3.3.0+)
patient: Patient;
};
Properties
Hide properties
Hide properties
string
Optional. Unique identifier for the encounter.
- For Patient Summary and ambient interoperability, pass your FHIR encounter id.
-
When this value is present, the SDK maps it to
emr_encounter_idfor ambient interoperability and Patient Summary lookup. Use the same value as CKGfhir_encounter_id. - Accepts a UUID or non-UUID value, at most 36 characters (). The Web SDK does not validate length or format.
- For Patient Summary in the Headed Web SDK (v3.3.0 and later), this value must match the encounter id in the FHIR data you ingested into CKG. Refer to Patient Summary in Web SDK for more information.
-
Set this value on
encounter.identifieronly. Do not useambientOptions.emrEncounterIdfor Patient Summary. Refer to AmbientOptions.
string
Optional. Required for Patient Summary generation at login and for the Patient Summary UI on the patient profile.
-
You supply this id. Suki does not. Take it from your EMR or FHIR Practitioner resource. Use the same value you send to CKG as
fhir_practitioner_id. -
From Web SDK v3.3.0, pass this value when you initialize so generation can run at login. Pass it again when you mount, and keep it on every
setEncountercall or Reactencounterprop update, so the headed patient profile can load the summary. -
setEncounter(or the Reactencounterprop) updates which encounter the profile loads. It does not generate again. To generate for a different practitioner, initialize the SDK again with the newencounter.practitionerFhirId. Remounting the iframe alone is not enough. Refer to Patient Summary in Web SDK for more information. -
Do not use auth
providerIdasencounter.practitionerFhirId. The SDK does not map one field to the other. -
If
identifierorpractitionerFhirIdis missing from encounter context when the patient profile loads, the Patient Summary UI stays hidden.
Patient
required
Patient information for the encounter.