List All Interactions
Lists all existing interactions.
Query Parameters
The status of the encounter. To fetch for multiple status pass the same parameter again.
A unique identifier for the patient.
Response
A unique identifier for the encounter, essential for tracking and referencing specific patient interactions.
The time period during which the encounter takes place.
The start date/time of the encounter. (UTC)
The end date/time of the encounter. (UTC)
Timezone offset for endedAt
Timezone offset for startedAt
Indicates the current state of the encounter, crucial for understanding the progression and current state of care.
planned, in-progress, on-hold, completed, cancelled, deleted The specific type of encounter, providing context about the nature and setting of the patient interaction.
first_consultation, consultation, emergency, inpatient, outpatient A readable name for the interaction
FHIR reference to patient identifier.
FHIR reference to patient birth date.
FHIR reference to patient gender. Ensures the documentation is written with the correct pronouns.
male, female, unknown, other FHIR reference to Text representation of the full name. Ensures the patient is referred by their name in the documentation.
FHIR reference to patient extension Individual Pronouns.
Was this page helpful?