FamilyMemberHistory constructor
- @Default(R5ResourceType.FamilyMemberHistory) @JsonKey(unknownEnumValue: R5ResourceType.FamilyMemberHistory) 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, - List<
FhirCanonical> ? instantiatesCanonical, - List<
FhirUri> ? instantiatesUri, - @JsonKey(name: '_instantiatesUri') List<
Element> ? instantiatesUriElement, - FhirCode? status,
- @JsonKey(name: '_status') Element? statusElement,
- CodeableConcept? dataAbsentReason,
- required Reference patient,
- FhirDateTime? date,
- @JsonKey(name: '_date') Element? dateElement,
- List<
FamilyMemberHistoryParticipant> ? participant, - String? name,
- @JsonKey(name: '_name') Element? nameElement,
- required CodeableConcept relationship,
- CodeableConcept? sex,
- Period? bornPeriod,
- FhirDate? bornDate,
- @JsonKey(name: '_bornDate') Element? bornDateElement,
- String? bornString,
- @JsonKey(name: '_bornString') Element? bornStringElement,
- Age? ageAge,
- Range? ageRange,
- String? ageString,
- @JsonKey(name: '_ageString') Element? ageStringElement,
- FhirBoolean? estimatedAge,
- @JsonKey(name: '_estimatedAge') Element? estimatedAgeElement,
- FhirBoolean? deceasedBoolean,
- @JsonKey(name: '_deceasedBoolean') Element? deceasedBooleanElement,
- Age? deceasedAge,
- Range? deceasedRange,
- FhirDate? deceasedDate,
- @JsonKey(name: '_deceasedDate') Element? deceasedDateElement,
- String? deceasedString,
- @JsonKey(name: '_deceasedString') Element? deceasedStringElement,
- List<
CodeableReference> ? reason, - List<
Annotation> ? note, - List<
FamilyMemberHistoryCondition> ? condition, - List<
FamilyMemberHistoryProcedure> ? procedure,
FamilyMemberHistory Significant health conditions for a person related to the patient relevant in the context of care for the patient.
resourceType
This is a FamilyMemberHistory 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
Business identifiers assigned to this family member history
by the performer or other systems which remain constant as the resource
is updated and propagates from server to server.
instantiatesCanonical
The URL pointing to a FHIR-defined protocol,
guideline, orderset or other definition that is adhered to in whole or
in part by this FamilyMemberHistory.
instantiatesUri
The URL pointing to an externally maintained protocol,
guideline, orderset or other definition that is adhered to in whole or
in part by this FamilyMemberHistory.
instantiatesUriElement
("_instantiatesUri") Extensions for
instantiatesUri
status
A code specifying the status of the record of the family history
of a specific family member.
statusElement
("_status") Extensions for status
dataAbsentReason
Describes why the family member's history is not
available.
patient
The person who this history concerns.
date
The date (and possibly time) when the family member history was
recorded or last updated.
dateElement
("_date") Extensions for date
participant
Indicates who or what participated in the activities
related to the family member history and how they were involved.
name
This will either be a name or a description; e.g. "Aunt Susan",
"my cousin with the red hair".
nameElement
("_name") Extensions for name
relationship
The type of relationship this person has to the patient
(father, mother, brother etc.).
sex
The birth sex of the family member.
bornPeriod
The actual or approximate date of birth of the relative.
bornDate
The actual or approximate date of birth of the relative.
bornDateElement
("_bornDate") Extensions for bornDate
bornString
The actual or approximate date of birth of the relative.
bornStringElement
("_bornString") Extensions for bornString
ageAge
The age of the relative at the time the family member history is
recorded.
ageRange
The age of the relative at the time the family member history
is recorded.
ageString
The age of the relative at the time the family member history
is recorded.
ageStringElement
("_ageString") Extensions for ageString
estimatedAge
If true, indicates that the age value specified is an
estimated value.
estimatedAgeElement
("_estimatedAge") Extensions for estimatedAge
deceasedBoolean
Deceased flag or the actual or approximate age of the
relative at the time of death for the family member history record.
deceasedBooleanElement
("_deceasedBoolean") Extensions for
deceasedBoolean
deceasedAge
Deceased flag or the actual or approximate age of the
relative at the time of death for the family member history record.
deceasedRange
Deceased flag or the actual or approximate age of the
relative at the time of death for the family member history record.
deceasedDate
Deceased flag or the actual or approximate age of the
relative at the time of death for the family member history record.
deceasedDateElement
("_deceasedDate") Extensions for deceasedDate
deceasedString
Deceased flag or the actual or approximate age of the
relative at the time of death for the family member history record.
deceasedStringElement
("_deceasedString") Extensions for deceasedString
reason
Describes why the family member history occurred in coded or
textual form, or Indicates a Condition, Observation, AllergyIntolerance,
or QuestionnaireResponse that justifies this family member history event.
note
This property allows a non condition-specific note to the made
about the related person. Ideally, the note would be in the condition
property, but this is not always possible.
condition
The significant Conditions (or condition) that the family
member had. This is a repeating section to allow a system to represent
more than one condition per resource, though there is nothing stopping
multiple resources - one per condition.
procedure
The significant Procedures (or procedure) that the family
member had. This is a repeating section to allow a system to represent
more than one procedure per resource, though there is nothing stopping
multiple resources - one per procedure.
Implementation
const factory FamilyMemberHistory({
/// [resourceType] This is a FamilyMemberHistory resource
@Default(R5ResourceType.FamilyMemberHistory)
@JsonKey(unknownEnumValue: R5ResourceType.FamilyMemberHistory)
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] Business identifiers assigned to this family member
/// history by the performer or other systems which remain constant as the
/// resource is updated and propagates from server to server.
List<Identifier>? identifier,
/// [instantiatesCanonical] The URL pointing to a FHIR-defined protocol,
/// guideline, orderset or other definition that is adhered to in whole or
/// in part by this FamilyMemberHistory.
List<FhirCanonical>? instantiatesCanonical,
/// [instantiatesUri] The URL pointing to an externally maintained
/// protocol, guideline, orderset or other definition that is adhered to
/// in whole or in part by this FamilyMemberHistory.
List<FhirUri>? instantiatesUri,
/// [instantiatesUriElement] ("_instantiatesUri") Extensions for
/// instantiatesUri
@JsonKey(name: '_instantiatesUri') List<Element>? instantiatesUriElement,
/// [status] A code specifying the status of the record of the family
/// history of a specific family member.
FhirCode? status,
/// [statusElement] ("_status") Extensions for status
@JsonKey(name: '_status') Element? statusElement,
/// [dataAbsentReason] Describes why the family member's history is not
/// available.
CodeableConcept? dataAbsentReason,
/// [patient] The person who this history concerns.
required Reference patient,
/// [date] The date (and possibly time) when the family member history was
/// recorded or last updated.
FhirDateTime? date,
/// [dateElement] ("_date") Extensions for date
@JsonKey(name: '_date') Element? dateElement,
/// [participant] Indicates who or what participated in the activities
/// related to the family member history and how they were involved.
List<FamilyMemberHistoryParticipant>? participant,
/// [name] This will either be a name or a description; e.g. "Aunt Susan",
/// "my cousin with the red hair".
String? name,
/// [nameElement] ("_name") Extensions for name
@JsonKey(name: '_name') Element? nameElement,
/// [relationship] The type of relationship this person has to the patient
/// (father, mother, brother etc.).
required CodeableConcept relationship,
/// [sex] The birth sex of the family member.
CodeableConcept? sex,
/// [bornPeriod] The actual or approximate date of birth of the relative.
Period? bornPeriod,
/// [bornDate] The actual or approximate date of birth of the relative.
FhirDate? bornDate,
/// [bornDateElement] ("_bornDate") Extensions for bornDate
@JsonKey(name: '_bornDate') Element? bornDateElement,
/// [bornString] The actual or approximate date of birth of the relative.
String? bornString,
/// [bornStringElement] ("_bornString") Extensions for bornString
@JsonKey(name: '_bornString') Element? bornStringElement,
/// [ageAge] The age of the relative at the time the family member history
/// is recorded.
Age? ageAge,
/// [ageRange] The age of the relative at the time the family member
/// history is recorded.
Range? ageRange,
/// [ageString] The age of the relative at the time the family member
/// history is recorded.
String? ageString,
/// [ageStringElement] ("_ageString") Extensions for ageString
@JsonKey(name: '_ageString') Element? ageStringElement,
/// [estimatedAge] If true, indicates that the age value specified is an
/// estimated value.
FhirBoolean? estimatedAge,
/// [estimatedAgeElement] ("_estimatedAge") Extensions for estimatedAge
@JsonKey(name: '_estimatedAge') Element? estimatedAgeElement,
/// [deceasedBoolean] Deceased flag or the actual or approximate age of the
/// relative at the time of death for the family member history record.
FhirBoolean? deceasedBoolean,
/// [deceasedBooleanElement] ("_deceasedBoolean") Extensions for
/// deceasedBoolean
@JsonKey(name: '_deceasedBoolean') Element? deceasedBooleanElement,
/// [deceasedAge] Deceased flag or the actual or approximate age of the
/// relative at the time of death for the family member history record.
Age? deceasedAge,
/// [deceasedRange] Deceased flag or the actual or approximate age of the
/// relative at the time of death for the family member history record.
Range? deceasedRange,
/// [deceasedDate] Deceased flag or the actual or approximate age of the
/// relative at the time of death for the family member history record.
FhirDate? deceasedDate,
/// [deceasedDateElement] ("_deceasedDate") Extensions for deceasedDate
@JsonKey(name: '_deceasedDate') Element? deceasedDateElement,
/// [deceasedString] Deceased flag or the actual or approximate age of the
/// relative at the time of death for the family member history record.
String? deceasedString,
/// [deceasedStringElement] ("_deceasedString") Extensions for
/// deceasedString
@JsonKey(name: '_deceasedString') Element? deceasedStringElement,
/// [reason] Describes why the family member history occurred in coded or
/// textual form, or Indicates a Condition, Observation,
/// AllergyIntolerance, or QuestionnaireResponse that justifies this
/// family member history event.
List<CodeableReference>? reason,
/// [note] This property allows a non condition-specific note to the made
/// about the related person. Ideally, the note would be in the condition
/// property, but this is not always possible.
List<Annotation>? note,
/// [condition] The significant Conditions (or condition) that the family
/// member had. This is a repeating section to allow a system to represent
/// more than one condition per resource, though there is nothing stopping
/// multiple resources - one per condition.
List<FamilyMemberHistoryCondition>? condition,
/// [procedure] The significant Procedures (or procedure) that the family
/// member had. This is a repeating section to allow a system to represent
/// more than one procedure per resource, though there is nothing stopping
/// multiple resources - one per procedure.
List<FamilyMemberHistoryProcedure>? procedure,
}) = _FamilyMemberHistory;