Patient class
Patient Demographics and other administrative information about an individual or animal receiving care or other health-related services.
- Mixed in types
- Annotations
-
- @freezed
Constructors
-
Patient({@Default(R5ResourceType.Patient) @JsonKey(unknownEnumValue: R5ResourceType.Patient) 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, FhirBoolean? active, @JsonKey(name: '_active') Element? activeElement, List<HumanName> ? name, List<ContactPoint> ? telecom, FhirCode? gender, @JsonKey(name: '_gender') Element? genderElement, FhirDate? birthDate, @JsonKey(name: '_birthDate') Element? birthDateElement, FhirBoolean? deceasedBoolean, @JsonKey(name: '_deceasedBoolean') Element? deceasedBooleanElement, FhirDateTime? deceasedDateTime, @JsonKey(name: '_deceasedDateTime') Element? deceasedDateTimeElement, List<Address> ? address, CodeableConcept? maritalStatus, FhirBoolean? multipleBirthBoolean, @JsonKey(name: '_multipleBirthBoolean') Element? multipleBirthBooleanElement, FhirInteger? multipleBirthInteger, @JsonKey(name: '_multipleBirthInteger') Element? multipleBirthIntegerElement, List<Attachment> ? photo, List<PatientContact> ? contact, List<PatientCommunication> ? communication, List<Reference> ? generalPractitioner, Reference? managingOrganization, List<PatientLink> ? link}) -
Patient Demographics and other administrative information about an
individual or animal receiving care or other health-related services.
constfactory
-
Patient.fromJson(Map<
String, dynamic> json) -
Factory constructor, accepts Map<String, dynamic> as an argument
factory
- Patient.fromJsonString(String source)
-
Acts like a constructor, returns a Patient, accepts a
String as an argument, mostly because I got tired of typing it out
factory
- Patient.fromYaml(dynamic yaml)
-
Factory constructor that accepts a String in YAML format as an argument
factory
Properties
- active → FhirBoolean?
-
active Whether this patient record is in active use. Many systems use
this property to mark as non-current patients, such as those that have
not been seen for a period of time based on an organization's business
rules. It is often used to filter patient lists to exclude inactive
patients Deceased patients may also be marked as inactive for the same
reasons, but may be active for some time after death.
no setterinherited
- activeElement → Element?
-
activeElement ("_active") Extensions for active
no setterinherited
-
address
→ List<
Address> ? -
address An address for the individual.
no setterinherited
- birthDate → FhirDate?
-
birthDate The date of birth for the individual.
no setterinherited
- birthDateElement → Element?
-
birthDateElement ("_birthDate") Extensions for birthDate
no setterinherited
-
communication
→ List<
PatientCommunication> ? -
communication A language which may be used to communicate with the
patient about his or her health.
no setterinherited
-
contact
→ List<
PatientContact> ? -
contact A contact party (e.g. guardian, partner, friend) for the
patient.
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
→ $PatientCopyWith<
Patient> -
no setterinherited
- dbId → int?
-
no setterinherited
- deceasedBoolean → FhirBoolean?
-
deceasedBoolean Indicates if the individual is deceased or not.
no setterinherited
- deceasedBooleanElement → Element?
-
deceasedBooleanElement ("_deceasedBoolean") Extensions for
deceasedBoolean
no setterinherited
- deceasedDateTime → FhirDateTime?
-
deceasedDateTime Indicates if the individual is deceased or not.
no setterinherited
- deceasedDateTimeElement → Element?
-
deceasedDateTimeElement ("_deceasedDateTime") Extensions for
deceasedDateTime
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
- gender → FhirCode?
-
gender Administrative Gender - the gender that the patient is
considered to have for administration and record keeping purposes.
no setterinherited
- genderElement → Element?
-
genderElement ("_gender") Extensions for gender
no setterinherited
-
generalPractitioner
→ List<
Reference> ? -
generalPractitioner Patient's nominated care provider.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
identifier
→ List<
Identifier> ? -
identifier An identifier for this patient.
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
-
link
→ List<
PatientLink> ? -
link Link to a Patient or RelatedPerson resource that concerns the
same actual individual.
no setterinherited
- managingOrganization → Reference?
-
managingOrganization Organization that is the custodian of the
patient record.
no setterinherited
- maritalStatus → CodeableConcept?
-
maritalStatus This field contains a patient's most recent marital
(civil) status.
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
- multipleBirthBoolean → FhirBoolean?
-
multipleBirthBoolean Indicates whether the patient is part of a
multiple (boolean) or indicates the actual birth order (integer).
no setterinherited
- multipleBirthBooleanElement → Element?
-
multipleBirthBooleanElement ("_multipleBirthBoolean") Extensions for
multipleBirthBoolean
no setterinherited
- multipleBirthInteger → FhirInteger?
-
multipleBirthInteger Indicates whether the patient is part of a
multiple (boolean) or indicates the actual birth order (integer).
no setterinherited
- multipleBirthIntegerElement → Element?
-
multipleBirthIntegerElement ("_multipleBirthInteger") Extensions for
multipleBirthInteger
no setterinherited
-
name
→ List<
HumanName> ? -
name A name associated with the individual.
no setterinherited
- path → String
-
Local Reference for this Resource, form is "ResourceType/Id"
no setterinherited
-
photo
→ List<
Attachment> ? -
photo Image of the patient.
no setterinherited
- resourceType → R5ResourceType
-
resourceType This is a Patient 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
-
telecom
→ List<
ContactPoint> ? -
telecom A contact detail (e.g. a telephone number or an email
address) by which the individual may be contacted.
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
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
-
updateAddressCity(
String city, [int index = 0]) → Patient -
updateAddressCountry(
String country, [int index = 0]) → Patient -
updateAddressDistrict(
String district, [int index = 0]) → Patient -
updateAddressLine(
List< String> line, [int index = 0]) → Patient -
updateAddressPeriod(
Period period, [int index = 0]) → Patient -
updateAddressPostalCode(
String postalCode, [int index = 0]) → Patient -
updateAddressState(
String state, [int index = 0]) → Patient -
updateAddressText(
String text, [int index = 0]) → Patient -
updateAddressType(
AddressType type, [int index = 0]) → Patient -
updateAddressUse(
AddressUse use, [int index = 0]) → Patient -
updateContactPointPeriod(
Period period, [int index = 0]) → Patient -
updateContactPointRank(
FhirPositiveInt rank, [int index = 0]) → Patient -
updateContactPointSystem(
ContactPointSystem system, [int index = 0]) → Patient -
updateContactPointUse(
ContactPointUse use, [int index = 0]) → Patient -
updateContactPointValue(
String value, [int index = 0]) → Patient -
updateDob(
DateTime newDob) → Patient -
updateHumanNameFamily(
String family, [int index = 0]) → Patient -
updateHumanNameGiven(
List< String> given, [int index = 0]) → Patient -
updateHumanNamePeriod(
Period period, [int index = 0]) → Patient -
updateHumanNamePrefix(
List< String> prefix, [int index = 0]) → Patient -
updateHumanNameSuffix(
List< String> suffix, [int index = 0]) → Patient -
updateHumanNameText(
String text, [int index = 0]) → Patient -
updateHumanNameUse(
HumanNameUse use, [int index = 0]) → Patient -
updateSexAtBirth(
String sexAtBirth) → Patient -
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