EncounterHistory class

EncounterHistory A record of significant events/milestones key data throughout the history of an Encounter, often tracked for specific purposes such as billing.

Mixed in types
Annotations
  • @freezed

Constructors

EncounterHistory({@Default(R5ResourceType.EncounterHistory) @JsonKey(unknownEnumValue: R5ResourceType.EncounterHistory) R5ResourceType resourceType, @JsonKey(includeFromJson: true, includeToJson: false) int? dbId, @JsonKey(name: 'id') FhirId? 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, Reference? encounter, List<Identifier>? identifier, FhirCode? status, @JsonKey(name: '_status') Element? statusElement, @JsonKey(name: 'class') required CodeableConcept class_, List<CodeableConcept>? type, List<CodeableReference>? serviceType, Reference? subject, CodeableConcept? subjectStatus, Period? actualPeriod, FhirDateTime? plannedStartDate, @JsonKey(name: '_plannedStartDate') Element? plannedStartDateElement, FhirDateTime? plannedEndDate, @JsonKey(name: '_plannedEndDate') Element? plannedEndDateElement, FhirDuration? length, List<EncounterHistoryLocation>? location})
EncounterHistory A record of significant events/milestones key data throughout the history of an Encounter, often tracked for specific purposes such as billing.
const
factory
EncounterHistory.fromJson(Map<String, dynamic> json)
Factory constructor, accepts Map<String, dynamic> as an argument
factory
EncounterHistory.fromJsonString(String source)
Acts like a constructor, returns a EncounterHistory, accepts a String as an argument, mostly because I got tired of typing it out
factory
EncounterHistory.fromYaml(dynamic yaml)
Factory constructor that accepts a String in YAML format as an argument
factory

Properties

actualPeriod Period?
actualPeriod The start and end time associated with this set of values associated with the encounter, may be different to the planned times for various reasons.
no setterinherited
class_ CodeableConcept
class_ ("class") Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.
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, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.
no setterinherited
copyWith → $EncounterHistoryCopyWith<EncounterHistory>
no setterinherited
dbId int?
no setterinherited
encounter Reference?
encounter The Encounter associated with this set of historic values.
no setterinherited
extension_ List<FhirExtension>?
extension_ ("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 managable, 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 FhirId?
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
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 ("_implicitRules") Extensions for implicitRules
no setterinherited
language FhirCode?
language The base language in which the resource is written.
no setterinherited
languageElement Element?
languageElement ("_language") Extensions for language
no setterinherited
length FhirDuration?
length Actual quantity of time the encounter lasted. This excludes the time during leaves of absence. When missing it is the time in between the start and end values.
no setterinherited
location List<EncounterHistoryLocation>?
location The location of the patient at this point in the encounter, the multiple cardinality permits de-normalizing the levels of the location hierarchy, such as site/ward/room/bed.
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 managable, 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
path String
Local Reference for this Resource, form is "ResourceType/Id"
no setterinherited
plannedEndDate FhirDateTime?
plannedEndDate The planned end date/time (or discharge date) of the encounter.
no setterinherited
plannedEndDateElement Element?
plannedEndDateElement ("_plannedEndDate") Extensions for plannedEndDate
no setterinherited
plannedStartDate FhirDateTime?
plannedStartDate The planned start date/time (or admission date) of the encounter.
no setterinherited
plannedStartDateElement Element?
plannedStartDateElement ("_plannedStartDate") Extensions for plannedStartDate
no setterinherited
resourceType R5ResourceType
resourceType This is a EncounterHistory resource
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
serviceType List<CodeableReference>?
serviceType Broad categorization of the service that is to be provided (e.g. cardiology).
no setterinherited
status FhirCode?
status planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown.
no setterinherited
statusElement Element?
statusElement ("_status") Extensions for status
no setterinherited
subject Reference?
subject The patient or group related to this encounter. In some use-cases the patient MAY not be present, such as a case meeting about a patient between several practitioners or a careteam.
no setterinherited
subjectStatus CodeableConcept?
subjectStatus The subjectStatus value can be used to track the patient's status within the encounter. It details whether the patient has arrived or departed, has been triaged or is currently in a waiting status.
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
override
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