RelatedPerson class

RelatedPerson Information about a person that is involved in the care

Mixed in types

• Resource

Annotations

• @freezed

Constructors

RelatedPerson({@Default(R4ResourceType.RelatedPerson) @JsonKey(unknownEnumValue: R4ResourceType.RelatedPerson) 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, FhirBoolean? active, @JsonKey(name: '_active') Element? activeElement, required Reference patient, List<CodeableConcept>? relationship, List<HumanName>? name, List<ContactPoint>? telecom, FhirCode? gender, @JsonKey(name: '_gender') Element? genderElement, FhirDate? birthDate, @JsonKey(name: '_birthDate') Element? birthDateElement, List<Address>? address, List<Attachment>? photo, Period? period, List<RelatedPersonCommunication>? communication})

RelatedPerson Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.

const

factory

RelatedPerson.fromJson(Map<String, dynamic> json)

Factory constructor, accepts Map<String, dynamic> as an argument

factory

RelatedPerson.fromJsonString(String source)

Acts like a constructor, returns a RelatedPerson, accepts a String as an argument, mostly because I got tired of typing it out

factory

RelatedPerson.fromYaml(dynamic yaml)

Factory constructor that accepts a String in YAML format as an argument

factory

Properties

active → FhirBoolean?

active Whether this related person record is in active use.

no setter, inherited

activeElement → Element?

activeElement Extensions for active

no setter, inherited

address → List<Address>?

address Address where the related person can be contacted or visited.

no setter, inherited

birthDate → FhirDate?

birthDate The date on which the related person was born.

no setter, inherited

birthDateElement → Element?

birthDateElement Extensions for birthDate

no setter, inherited

communication → List<RelatedPersonCommunication>?

communication A language which may be used to communicate with about the patient's health.

no setter, inherited

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 setter, inherited

copyWith → $RelatedPersonCopyWith<RelatedPerson>

no setter, inherited

dbId → int?

no setter, inherited

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 setter, inherited

fhirId → String?

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

no setter, inherited

gender → FhirCode?

gender Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.

no setter, inherited

genderElement → Element?

genderElement Extensions for gender

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

identifier → List<Identifier>?

identifier Identifier for a person within a particular scope.

no setter, inherited

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 setter, inherited

implicitRulesElement → Element?

implicitRulesElement Extensions for implicitRules

no setter, inherited

language → FhirCode?

language The base language in which the resource is written.

no setter, inherited

languageElement → Element?

languageElement Extensions for language

no setter, inherited

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 setter, inherited

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 setter, inherited

name → List<HumanName>?

name A name associated with the person.

no setter, inherited

path → String

Local Reference for this Resource, form is "ResourceType/Id"

no setter, inherited

patient → Reference

patient The patient this person is related to.

no setter, inherited

period → Period?

period The period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknown.

no setter, inherited

photo → List<Attachment>?

photo Image of the person.

no setter, inherited

relationship → List<CodeableConcept>?

relationship The nature of the relationship between a patient and the related person.

no setter, inherited

resourceType → R4ResourceType

no setter, inherited

resourceTypeString → String?

produce a string of the resourceType

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

telecom → List<ContactPoint>?

telecom A contact detail for the person, e.g. a telephone number or an email address.

no setter, inherited

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 setter, inherited

thisReference → Reference

Convenience method to return a Reference referring to that Resource

no setter, inherited

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

updateAddressCity(String city, [int index = 0]) → RelatedPerson

updateAddressCountry(String country, [int index = 0]) → RelatedPerson

updateAddressDistrict(String district, [int index = 0]) → RelatedPerson

updateAddressLine(List<String> line, [int index = 0]) → RelatedPerson

updateAddressPeriod(Period period, [int index = 0]) → RelatedPerson

updateAddressPostalCode(String postalCode, [int index = 0]) → RelatedPerson

updateAddressState(String state, [int index = 0]) → RelatedPerson

updateAddressText(String text, [int index = 0]) → RelatedPerson

updateAddressType(AddressType type, [int index = 0]) → RelatedPerson

updateAddressUse(AddressUse use, [int index = 0]) → RelatedPerson

updateContactPointPeriod(Period period, [int index = 0]) → RelatedPerson

updateContactPointRank(FhirPositiveInt rank, [int index = 0]) → RelatedPerson

updateContactPointSystem(ContactPointSystem system, [int index = 0]) → RelatedPerson

updateContactPointUse(ContactPointUse use, [int index = 0]) → RelatedPerson

updateContactPointValue(String value, [int index = 0]) → RelatedPerson

updateHumanNameFamily(String family, [int index = 0]) → RelatedPerson

updateHumanNameGiven(List<String> given, [int index = 0]) → RelatedPerson

updateHumanNamePeriod(Period period, [int index = 0]) → RelatedPerson

updateHumanNamePrefix(List<String> prefix, [int index = 0]) → RelatedPerson

updateHumanNameSuffix(List<String> suffix, [int index = 0]) → RelatedPerson

updateHumanNameText(String text, [int index = 0]) → RelatedPerson

updateHumanNameUse(HumanNameUse use, [int index = 0]) → RelatedPerson

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