Encounter class
Encounter An interaction between a patient and healthcare provider(s)
- Mixed in types
- Annotations
-
- @freezed
Constructors
-
Encounter({@Default(R4ResourceType.Encounter) @JsonKey(unknownEnumValue: R4ResourceType.Encounter) R4ResourceType resourceType, @JsonKey(includeFromJson: true, includeToJson: false) int? dbId, @JsonKey(name: 'id') String? fhirId, FhirMeta? meta, FhirUri? implicitRules, @JsonKey(name: '_implicitRules') Element? implicitRulesElement, FhirCode? language, @JsonKey(name: '_language') Element? languageElement, Narrative? text, List<
Resource> ? contained, @JsonKey(name: 'extension') List<FhirExtension> ? extension_, List<FhirExtension> ? modifierExtension, List<Identifier> ? identifier, FhirCode? status, @JsonKey(name: '_status') Element? statusElement, List<EncounterStatusHistory> ? statusHistory, @JsonKey(name: 'class') required Coding class_, List<EncounterClassHistory> ? classHistory, List<CodeableConcept> ? type, CodeableConcept? serviceType, CodeableConcept? priority, Reference? subject, List<Reference> ? episodeOfCare, List<Reference> ? basedOn, List<EncounterParticipant> ? participant, List<Reference> ? appointment, Period? period, FhirDuration? length, List<CodeableConcept> ? reasonCode, List<Reference> ? reasonReference, List<EncounterDiagnosis> ? diagnosis, List<Reference> ? account, EncounterHospitalization? hospitalization, List<EncounterLocation> ? location, Reference? serviceProvider, Reference? partOf}) -
Encounter An interaction between a patient and healthcare provider(s)
for the purpose of providing healthcare service(s) or assessing the health
status of a patient.
constfactory
-
Encounter.fromJson(Map<
String, dynamic> json) -
Factory constructor, accepts Map<String, dynamic> as an argument
factory
- Encounter.fromJsonString(String source)
-
Acts like a constructor, returns a Encounter, accepts a
String as an argument, mostly because I got tired of typing it out
factory
- Encounter.fromYaml(dynamic yaml)
-
Factory constructor that accepts a String in YAML format as an argument
factory
Properties
-
account
→ List<
Reference> ? -
account The set of accounts that may be used for billing for this
Encounter.
no setterinherited
-
appointment
→ List<
Reference> ? -
appointment The appointment that scheduled this encounter.
no setterinherited
-
basedOn
→ List<
Reference> ? -
basedOn The request this encounter satisfies (e.g. incoming referral or
procedure request).
no setterinherited
- class_ → Coding
-
class
Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.no setterinherited -
classHistory
→ List<
EncounterClassHistory> ? -
classHistory The class history permits the tracking of the encounters
transitions without needing to go through the resource history. This
would be used for a case where an admission starts of as an emergency
encounter, then transitions into an inpatient scenario. Doing this and not
restarting a new encounter ensures that any lab/diagnostic results can
more easily follow the patient and not require re-processing and not get
lost or cancelled during a kind of discharge from emergency to inpatient.
no setterinherited
-
contained
→ List<
Resource> ? -
contained These resources do not have an independent existence apart
from the resource that contains them - they cannot be identified
independently, and nor can they have their own independent transaction
scope.
no setterinherited
-
copyWith
→ $EncounterCopyWith<
Encounter> -
no setterinherited
- dbId → int?
-
no setterinherited
-
diagnosis
→ List<
EncounterDiagnosis> ? -
diagnosis The list of diagnosis relevant to this encounter.
no setterinherited
-
episodeOfCare
→ List<
Reference> ? -
episodeOfCare Where a specific encounter should be classified as a part
of a specific episode(s) of care this field should be used. This
association can facilitate grouping of related encounters together for a
specific purpose, such as government reporting, issue tracking,
association via a common problem. The association is recorded on the
encounter as these are typically created after the episode of care and
grouped on entry rather than editing the episode of care to append another
encounter to it (the episode of care could span years).
no setterinherited
-
extension_
→ List<
FhirExtension> ? -
extension_ May be used to represent additional information that is not
part of the basic definition of the resource. To make the use of
extensions safe and manageable, there is a strict set of governance
applied to the definition and use of extensions. Though any implementer
can define an extension, there is a set of requirements that SHALL be met
as part of the definition of the extension.
no setterinherited
- fhirId → String?
-
id The logical id of the resource, as used in the URL for the resource.
Once assigned, this value never changes.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- hospitalization → EncounterHospitalization?
-
hospitalization Details about the admission to a healthcare service.
no setterinherited
-
identifier
→ List<
Identifier> ? -
identifier Identifier(s) by which this encounter is known.
no setterinherited
- implicitRules → FhirUri?
-
implicitRules A reference to a set of rules that were followed when the
resource was constructed, and which must be understood when processing the
content. Often, this is a reference to an implementation guide that
defines the special rules along with other profiles etc.
no setterinherited
- implicitRulesElement → Element?
-
implicitRulesElement Extensions for implicitRules
no setterinherited
- language → FhirCode?
-
language The base language in which the resource is written.
no setterinherited
- languageElement → Element?
-
languageElement Extensions for language
no setterinherited
- length → FhirDuration?
-
length Quantity of time the encounter lasted. This excludes the time
during leaves of absence.
no setterinherited
-
location
→ List<
EncounterLocation> ? -
location List of locations where the patient has been during this
encounter.
no setterinherited
- meta → FhirMeta?
-
meta The metadata about the resource. This is content that is
maintained by the infrastructure. Changes to the content might not always
be associated with version changes to the resource.
no setterinherited
-
modifierExtension
→ List<
FhirExtension> ? -
modifierExtension May be used to represent additional information that
is not part of the basic definition of the resource and that modifies the
understanding of the element that contains it and/or the understanding of
the containing element's descendants. Usually modifier elements provide
negation or qualification. To make the use of extensions safe and
manageable, there is a strict set of governance applied to the definition
and use of extensions. Though any implementer is allowed to define an
extension, there is a set of requirements that SHALL be met as part of the
definition of the extension. Applications processing a resource are
required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on
Resource or DomainResource (including cannot change the meaning of
modifierExtension itself).
no setterinherited
-
participant
→ List<
EncounterParticipant> ? -
participant The list of people responsible for providing the service.
no setterinherited
- partOf → Reference?
-
partOf Another Encounter of which this encounter is a part of
(administratively or in time).
no setterinherited
- path → String
-
Local Reference for this Resource, form is "ResourceType/Id"
no setterinherited
- period → Period?
-
period The start and end time of the encounter.
no setterinherited
- priority → CodeableConcept?
-
priority Indicates the urgency of the encounter.
no setterinherited
-
reasonCode
→ List<
CodeableConcept> ? -
reasonCode Reason the encounter takes place, expressed as a code. For
admissions, this can be used for a coded admission diagnosis.
no setterinherited
-
reasonReference
→ List<
Reference> ? -
reasonReference Reason the encounter takes place, expressed as a code.
For admissions, this can be used for a coded admission diagnosis.
no setterinherited
- resourceType → R4ResourceType
-
no setterinherited
- resourceTypeString → String?
-
produce a string of the resourceType
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- serviceProvider → Reference?
-
serviceProvider The organization that is primarily responsible for this
Encounter's services. This MAY be the same as the organization on the
Patient record, however it could be different, such as if the actor
performing the services was from an external organization (which may be
billed seperately) for an external consultation. Refer to the example
bundle showing an abbreviated set of Encounters for a colonoscopy.
no setterinherited
- serviceType → CodeableConcept?
-
serviceType Broad categorization of the service that is to be provided
(e.g. cardiology).
no setterinherited
- status → FhirCode?
-
status planned | arrived | triaged | in-progress | onleave | finished |
cancelled +.
no setterinherited
- statusElement → Element?
-
statusElement Extensions for status
no setterinherited
-
statusHistory
→ List<
EncounterStatusHistory> ? -
statusHistory The status history permits the encounter resource to
contain the status history without needing to read through the historical
versions of the resource, or even have the server store them.
no setterinherited
- subject → Reference?
-
subject The patient or group present at the encounter.
no setterinherited
- text → Narrative?
-
text A human-readable narrative that contains a summary of the resource
and can be used to represent the content of the resource to a human. The
narrative need not encode all the structured data, but is required to
contain sufficient detail to make it "clinically safe" for a human to just
read the narrative. Resource definitions may define what content should be
represented in the narrative to ensure clinical safety.
no setterinherited
- thisReference → Reference
-
Convenience method to return a Reference referring to that Resource
no setterinherited
-
type
→ List<
CodeableConcept> ? -
type Specific type of encounter (e.g. e-mail consultation, surgical
day-care, skilled nursing, rehabilitation).
no setterinherited
Methods
-
newId(
) → Resource -
returns the same resource with a new ID (even if there is already an ID
present)
inherited
-
newIdIfNoId(
) → Resource -
returns the same resource with a new ID if there is no current ID
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toDbJson(
) → Map< String, dynamic> -
The normal toJson ignores the dbId, and produces the fhirId as the id
However, if you're going to use this as a database entry, you have to
switch those two ids
inherited
-
toJson(
) → Map< String, dynamic> -
inherited
-
toJsonString(
) → String -
Another convenience method because more and more I'm transmitting FHIR
data as a String and not a Map
override
-
toString(
) → String -
A string representation of this object.
inherited
-
toYaml(
) → String -
Produces a Yaml formatted String version of the object
inherited
-
updateVersion(
{FhirMeta? oldMeta}) → Resource -
Updates the meta field of this Resource, updates the meta.lastUpdated
field, adds 1 to the version number
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited