Encounter constructor

const Encounter({ @Default(R5ResourceType.Encounter) @JsonKey(unknownEnumValue: R5ResourceType.Encounter) 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, List<Identifier>? identifier, FhirCode? status, @JsonKey(name: '_status') Element? statusElement, @JsonKey(name: 'class') List<CodeableConcept>? class_, CodeableConcept? priority, List<CodeableConcept>? type, List<CodeableReference>? serviceType, Reference? subject, CodeableConcept? subjectStatus, List<Reference>? episodeOfCare, List<Reference>? basedOn, List<Reference>? careTeam, Reference? partOf, Reference? serviceProvider, List<EncounterParticipant>? participant, List<Reference>? appointment, List<VirtualServiceDetail>? virtualService, Period? actualPeriod, FhirDateTime? plannedStartDate, @JsonKey(name: '_plannedStartDate') Element? plannedStartDateElement, FhirDateTime? plannedEndDate, @JsonKey(name: '_plannedEndDate') Element? plannedEndDateElement, FhirDuration? length, List<EncounterReason>? reason, List<EncounterDiagnosis>? diagnosis, List<Reference>? account, List<CodeableConcept>? dietPreference, List<CodeableConcept>? specialArrangement, List<CodeableConcept>? specialCourtesy, EncounterAdmission? admission, List<EncounterLocation>? location, })

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. Encounter is primarily used to record information about the actual activities that occurred, where Appointment is used to record planned activities.

resourceType This is a Encounter resource

id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

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.

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.

implicitRulesElement ("_implicitRules") Extensions for implicitRules

language The base language in which the resource is written.

languageElement ("_language") Extensions for language

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.

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.

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.

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).

identifier Identifier(s) by which this encounter is known.

status The current state of the encounter (not the state of the patient within the encounter - that is subjectState).

statusElement ("_status") Extensions for status

class_ ("class") Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.

priority Indicates the urgency of the encounter.

type Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).

serviceType Broad categorization of the service that is to be provided (e.g. cardiology).

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.

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.

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).

basedOn The request this encounter satisfies (e.g. incoming referral or procedure request).

careTeam The group(s) of individuals, organizations that are allocated to participate in this encounter. The participants backbone will record the actuals of when these individuals participated during the encounter.

partOf Another Encounter of which this encounter is a part of (administratively or in time).

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 colonoscopy example on the Encounter examples tab.

participant The list of people responsible for providing the service.

appointment The appointment that scheduled this encounter.

virtualService Connection details of a virtual service (e.g. conference call).

actualPeriod The actual start and end time of the encounter.

plannedStartDate The planned start date/time (or admission date) of the encounter.

plannedStartDateElement ("_plannedStartDate") Extensions for plannedStartDate

plannedEndDate The planned end date/time (or discharge date) of the encounter.

plannedEndDateElement ("_plannedEndDate") Extensions for plannedEndDate

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.

reason The list of medical reasons that are expected to be addressed during the episode of care.

diagnosis The list of diagnosis relevant to this encounter.

account The set of accounts that may be used for billing for this Encounter.

dietPreference Diet preferences reported by the patient.

specialArrangement Any special requests that have been made for this encounter, such as the provision of specific equipment or other things.

specialCourtesy Special courtesies that may be provided to the patient during the encounter (VIP, board member, professional courtesy).

admission Details about the stay during which a healthcare service is provided. This does not describe the event of admitting the patient, but rather any information that is relevant from the time of admittance until the time of discharge.

location List of locations where the patient has been during this encounter.

Implementation

const factory Encounter({
  /// [resourceType] This is a Encounter resource
  @Default(R5ResourceType.Encounter)
  @JsonKey(unknownEnumValue: R5ResourceType.Encounter)
  R5ResourceType resourceType,
  @JsonKey(includeFromJson: true, includeToJson: false) int? dbId,

  /// [id] The logical id of the resource, as used in the URL for the
  ///  resource. Once assigned, this value never changes.
  @JsonKey(name: 'id') FhirId? fhirId,

  /// [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.
  FhirMeta? meta,

  /// [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.
  FhirUri? implicitRules,

  /// [implicitRulesElement] ("_implicitRules") Extensions for implicitRules
  @JsonKey(name: '_implicitRules') Element? implicitRulesElement,

  /// [language] The base language in which the resource is written.
  FhirCode? language,

  /// [languageElement] ("_language") Extensions for language
  @JsonKey(name: '_language') Element? languageElement,

  /// [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.
  Narrative? text,

  /// [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.
  List<Resource>? contained,

  /// [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.
  @JsonKey(name: 'extension') List<FhirExtension>? extension_,

  /// [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).
  List<FhirExtension>? modifierExtension,

  /// [identifier] Identifier(s) by which this encounter is known.
  List<Identifier>? identifier,

  /// [status] The current state of the encounter (not the state of the
  ///  patient within the encounter - that is subjectState).
  FhirCode? status,

  /// [statusElement] ("_status") Extensions for status
  @JsonKey(name: '_status') Element? statusElement,

  /// [class_] ("class") Concepts representing classification of patient
  ///  encounter such as ambulatory (outpatient), inpatient, emergency, home
  ///  health or others due to local variations.
  @JsonKey(name: 'class') List<CodeableConcept>? class_,

  /// [priority] Indicates the urgency of the encounter.
  CodeableConcept? priority,

  /// [type] Specific type of encounter (e.g. e-mail consultation, surgical
  ///  day-care, skilled nursing, rehabilitation).
  List<CodeableConcept>? type,

  /// [serviceType] Broad categorization of the service that is to be
  ///  provided (e.g. cardiology).
  List<CodeableReference>? serviceType,

  /// [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.
  Reference? subject,

  /// [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.
  CodeableConcept? subjectStatus,

  /// [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).
  List<Reference>? episodeOfCare,

  /// [basedOn] The request this encounter satisfies (e.g. incoming referral
  ///  or procedure request).
  List<Reference>? basedOn,

  /// [careTeam] The group(s) of individuals, organizations that are
  ///  allocated to participate in this encounter. The participants backbone
  ///  will record the actuals of when these individuals participated during
  ///  the encounter.
  List<Reference>? careTeam,

  /// [partOf] Another Encounter of which this encounter is a part of
  ///  (administratively or in time).
  Reference? partOf,

  /// [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
  ///  colonoscopy example on the Encounter examples tab.
  Reference? serviceProvider,

  /// [participant] The list of people responsible for providing the service.
  List<EncounterParticipant>? participant,

  /// [appointment] The appointment that scheduled this encounter.
  List<Reference>? appointment,

  /// [virtualService] Connection details of a virtual service (e.g.
  ///  conference call).
  List<VirtualServiceDetail>? virtualService,

  /// [actualPeriod] The actual start and end time of the encounter.
  Period? actualPeriod,

  /// [plannedStartDate] The planned start date/time (or admission date) of
  ///  the encounter.
  FhirDateTime? plannedStartDate,

  /// [plannedStartDateElement] ("_plannedStartDate") Extensions for
  ///  plannedStartDate
  @JsonKey(name: '_plannedStartDate') Element? plannedStartDateElement,

  /// [plannedEndDate] The planned end date/time (or discharge date) of the
  ///  encounter.
  FhirDateTime? plannedEndDate,

  /// [plannedEndDateElement] ("_plannedEndDate") Extensions for
  ///  plannedEndDate
  @JsonKey(name: '_plannedEndDate') Element? plannedEndDateElement,

  /// [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.
  FhirDuration? length,

  /// [reason] The list of medical reasons that are expected to be addressed
  ///  during the episode of care.
  List<EncounterReason>? reason,

  /// [diagnosis] The list of diagnosis relevant to this encounter.
  List<EncounterDiagnosis>? diagnosis,

  /// [account] The set of accounts that may be used for billing for this
  ///  Encounter.
  List<Reference>? account,

  /// [dietPreference] Diet preferences reported by the patient.
  List<CodeableConcept>? dietPreference,

  /// [specialArrangement] Any special requests that have been made for this
  ///  encounter, such as the provision of specific equipment or other things.
  List<CodeableConcept>? specialArrangement,

  /// [specialCourtesy] Special courtesies that may be provided to the
  ///  patient during the encounter (VIP, board member, professional
  ///  courtesy).
  List<CodeableConcept>? specialCourtesy,

  /// [admission] Details about the stay during which a healthcare service is
  ///  provided.This does not describe the event of admitting the patient,
  ///  but rather any information that is relevant from the time of
  ///  admittance until the time of discharge.
  EncounterAdmission? admission,

  /// [location] List of locations where  the patient has been during this
  ///  encounter.
  List<EncounterLocation>? location,
}) = _Encounter;