HumanName constructor

const HumanName({ @JsonKey(name: 'id') String? fhirId, @JsonKey(name: 'extension') List<FhirExtension>? extension_, HumanNameUse? use, @JsonKey(name: '_use') Element? useElement, String? text, @JsonKey(name: '_text') Element? textElement, String? family, @JsonKey(name: '_family') Element? familyElement, List<String>? given, @JsonKey(name: '_given') List<Element>? givenElement, List<String>? prefix, @JsonKey(name: '_prefix') List<Element>? prefixElement, List<String>? suffix, @JsonKey(name: '_suffix') List<Element>? suffixElement, Period? period, })

HumanName A name, normally of a human, that can be used for other living entities (e.g. animals but not organizations) that have been assigned names by a human and may need the use of name parts or the need for usage information.

id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

extension_ ("extension") May be used to represent additional information that is not part of the basic definition of the element. 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.

use Identifies the purpose for this name.

useElement ("_use") Extensions for use

text Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.

textElement ("_text") Extensions for text

family The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.

familyElement ("_family") Extensions for family

given Given name.

givenElement ("_given") Extensions for given

prefix Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.

prefixElement ("_prefix") Extensions for prefix

suffix Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.

suffixElement ("_suffix") Extensions for suffix

period Indicates the period of time when this name was valid for the named person.

Implementation

const factory HumanName({
  /// [id] Unique id for the element within a resource (for internal
  ///  references). This may be any string value that does not contain spaces.
  @JsonKey(name: 'id') String? fhirId,

  /// [extension_] ("extension") May be used to represent additional
  ///  information that is not part of the basic definition of the element.
  ///  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_,

  /// [use] Identifies the purpose for this name.
  HumanNameUse? use,

  /// [useElement] ("_use") Extensions for use
  @JsonKey(name: '_use') Element? useElement,

  /// [text] Specifies the entire name as it should be displayed e.g. on an
  ///  application UI. This may be provided instead of or as well as the
  ///  specific parts.
  String? text,

  /// [textElement] ("_text") Extensions for text
  @JsonKey(name: '_text') Element? textElement,

  /// [family] The part of a name that links to the genealogy. In some
  ///  cultures (e.g. Eritrea) the family name of a son is the first name of
  ///  his father.
  String? family,

  /// [familyElement] ("_family") Extensions for family
  @JsonKey(name: '_family') Element? familyElement,

  /// [given] Given name.
  List<String>? given,

  /// [givenElement] ("_given") Extensions for given
  @JsonKey(name: '_given') List<Element>? givenElement,

  /// [prefix] Part of the name that is acquired as a title due to academic,
  ///  legal, employment or nobility status, etc. and that appears at the
  ///  start of the name.
  List<String>? prefix,

  /// [prefixElement] ("_prefix") Extensions for prefix
  @JsonKey(name: '_prefix') List<Element>? prefixElement,

  /// [suffix] Part of the name that is acquired as a title due to academic,
  ///  legal, employment or nobility status, etc. and that appears at the end
  ///  of the name.
  List<String>? suffix,

  /// [suffixElement] ("_suffix") Extensions for suffix
  @JsonKey(name: '_suffix') List<Element>? suffixElement,

  /// [period] Indicates the period of time when this name was valid for the
  ///  named person.
  Period? period,
}) = _HumanName;