Page values for "References/Encounter"

"Docs" values

1 row is stored for this page

17 rows are stored for this page

Field	Field type	Value
Model	`String`	Encounter
Section	`String`	Classification & status
Field	`String`	status
FieldType	`String`	CharField(100)
Notes	`Text`	Nullable in DB; '''required''' in API. One of <code>StatusChoices</code> (see below)

Field	Field type	Value
Model	`String`	Encounter
Section	`String`	Classification & status
Field	`String`	status_history
FieldType	`String`	JSONField
Notes	`Text`	Default <code>{}</code>. Server-maintained. Shape: <code>{ "history": [{ "status": str, "moved_at": str (ISO datetime) }] }</code>

Field	Field type	Value
Model	`String`	Encounter
Section	`String`	Classification & status
Field	`String`	encounter_class
FieldType	`String`	CharField(100)
Notes	`Text`	Nullable in DB; '''required''' in API. One of <code>ClassChoices</code> (see below)

Field	Field type	Value
Model	`String`	Encounter
Section	`String`	Classification & status
Field	`String`	encounter_class_history
FieldType	`String`	JSONField
Notes	`Text`	Default <code>{}</code>. Server-maintained. Shape: <code>{ "history": [{ "status": str, "moved_at": str (ISO datetime) }] }</code>

Field	Field type	Value
Model	`String`	Encounter
Section	`String`	Classification & status
Field	`String`	priority
FieldType	`String`	CharField(100)
Notes	`Text`	Nullable in DB; '''required''' in API. One of <code>EncounterPriorityChoices</code> (see below)

Field	Field type	Value
Model	`String`	Encounter
Section	`String`	Classification & status
Field	`String`	external_identifier
FieldType	`String`	CharField(100)
Notes	`Text`	Nullable. Identifier from an external/source system

Field	Field type	Value
Model	`String`	Encounter
Section	`String`	Subject & facility
Field	`String`	patient
FieldType	`String`	FK → Patient
Notes	`Text`	<code>CASCADE</code>. The patient this encounter is for. Set on create only

Field	Field type	Value
Model	`String`	Encounter
Section	`String`	Subject & facility
Field	`String`	facility
FieldType	`String`	FK → Facility
Notes	`Text`	<code>PROTECT</code>. The facility where the encounter takes place. Set on create only

Field	Field type	Value
Model	`String`	Encounter
Section	`String`	Timing & disposition
Field	`String`	period
FieldType	`String`	JSONField
Notes	`Text`	Default <code>{}</code>. <code>PeriodSpec { start: datetime (tz-aware, optional), end: datetime (tz-aware, optional) }</code>. If both set, <code>start ≤ end</code>

Field	Field type	Value
Model	`String`	Encounter
Section	`String`	Timing & disposition
Field	`String`	hospitalization
FieldType	`String`	JSONField
Notes	`Text`	Default <code>{}</code>. <code>HospitalizationSpec</code> (see shape below). Nullable

Field	Field type	Value
Model	`String`	Encounter
Section	`String`	Timing & disposition
Field	`String`	discharge_summary_advice
FieldType	`String`	TextField
Notes	`Text`	Nullable. Free-text discharge advice. Explicitly cleared to <code>None</code> on update when omitted

Field	Field type	Value
Model	`String`	Encounter
Section	`String`	Care team
Field	`String`	care_team
FieldType	`String`	JSONField
Notes	`Text`	Default <code>{}</code>. Stored as a list of <code>{ "user_id": int, "role": Coding }</code> entries. '''Not''' writable on create/update (excluded); managed via the dedicated care-team write spec

Field	Field type	Value
Model	`String`	Encounter
Section	`String`	Care team
Field	`String`	care_team_users
FieldType	`String`	ArrayField[int]
Notes	`Text`	Platform-maintained denormalized cache of user IDs derived from <code>care_team</code> via <code>sync_care_team_users_cache()</code> on every save

Field	Field type	Value
Model	`String`	Encounter
Section	`String`	Organization cache, tags & extensions
Field	`String`	tags
FieldType	`String`	ArrayField[int]
Notes	`Text`	Tag IDs applied to the encounter. Serialized via <code>SingleFacilityTagManager().render_tags()</code>

Field	Field type	Value
Model	`String`	Encounter
Section	`String`	Organization cache, tags & extensions
Field	`String`	extensions
FieldType	`String`	JSONField
Notes	`Text`	Default <code>{}</code>. Open extension bag for deployment-specific metadata. Validated by <code>ExtensionValidator</code> against <code>ExtensionResource.encounter</code>

Field	Field type	Value
Model	`String`	Encounter
Section	`String`	PeriodSpec (period)
Field	`String`	start
FieldType	`String`	datetime
Notes	`Text`	Must be timezone-aware if provided

Field	Field type	Value
Model	`String`	Encounter
Section	`String`	PeriodSpec (period)
Field	`String`	end
FieldType	`String`	datetime
Notes	`Text`	Must be timezone-aware if provided