RelatedPerson constructor
- @Default(R5ResourceType.RelatedPerson) @JsonKey(unknownEnumValue: R5ResourceType.RelatedPerson) 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,
- 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 a patient's health or the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.
resourceType
This is a RelatedPerson 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 for a person within a particular scope.
active
Whether this related person record is in active use.
activeElement
("_active") Extensions for active
patient
The patient this person is related to.
relationship
The nature of the relationship between the related person
and the patient.
name
A name associated with the person.
telecom
A contact detail for the person, e.g. a telephone number or an
email address.
gender
Administrative Gender - the gender that the person is considered
to have for administration and record keeping purposes.
genderElement
("_gender") Extensions for gender
birthDate
The date on which the related person was born.
birthDateElement
("_birthDate") Extensions for birthDate
address
Address where the related person can be contacted or visited.
photo
Image of the person.
period
The period of time during which this relationship is or was
active. If there are no dates defined, then the interval is unknown.
communication
A language which may be used to communicate with the
related person about the patient's health.
Implementation
const factory RelatedPerson({
/// [resourceType] This is a RelatedPerson resource
@Default(R5ResourceType.RelatedPerson)
@JsonKey(unknownEnumValue: R5ResourceType.RelatedPerson)
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 for a person within a particular scope.
List<Identifier>? identifier,
/// [active] Whether this related person record is in active use.
FhirBoolean? active,
/// [activeElement] ("_active") Extensions for active
@JsonKey(name: '_active') Element? activeElement,
/// [patient] The patient this person is related to.
required Reference patient,
/// [relationship] The nature of the relationship between the related
/// person and the patient.
List<CodeableConcept>? relationship,
/// [name] A name associated with the person.
List<HumanName>? name,
/// [telecom] A contact detail for the person, e.g. a telephone number or
/// an email address.
List<ContactPoint>? telecom,
/// [gender] Administrative Gender - the gender that the person is
/// considered to have for administration and record keeping purposes.
FhirCode? gender,
/// [genderElement] ("_gender") Extensions for gender
@JsonKey(name: '_gender') Element? genderElement,
/// [birthDate] The date on which the related person was born.
FhirDate? birthDate,
/// [birthDateElement] ("_birthDate") Extensions for birthDate
@JsonKey(name: '_birthDate') Element? birthDateElement,
/// [address] Address where the related person can be contacted or visited.
List<Address>? address,
/// [photo] Image of the person.
List<Attachment>? photo,
/// [period] The period of time during which this relationship is or was
/// active. If there are no dates defined, then the interval is unknown.
Period? period,
/// [communication] A language which may be used to communicate with the
/// related person about the patient's health.
List<RelatedPersonCommunication>? communication,
}) = _RelatedPerson;