Datatypes
Class PersonName

"A word or term by which a person or thing is commonly and distinctively known." - Collins English Dictionary. This data type represents a person's name.
"A human's name with the ability to identify parts and usage." - HL7 FHIR, HumanName.

Attributes
«IVL_TS» Period effectiveDateRange effectiveDateRange

"Indicates the period of time when this name was valid for the named person." - HL7 FHIR, HumanName.period.

String family family

"The portion of a person's name that reflects the genealogy of the person. In western cultures, this is the 'last' name. In eastern cultures, the family name appears before the person's given name(s). In some cultures (e.g. Eritrea) the family name of a son is the first name of his father." - HL7 V3
"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." - HL7 FHIR, HumanName.family.
"Patient’s last name." - ASAP Standard for PDMP, PAT07: Last Name

String given given

"A set of names given to a person at birth, but not including the family name. In western cultures, this property would contain the 'first' and 'middle' names. Note that in some cultures, the given name is placed after the family name. Note also that this property contains multiple elements, so it can handle those situations where a person has more than one 'middle' name." - HL7 V3
"Given name." - HL7 FHIR, HumanName.given.
"Patient’s first name." - ASAP Standard for PDMP, PAT08: First Name
"Patient’s middle name or initial if available.
Used if available in pharmacy system and required by the PDMP." - ASAP Standard for PDMP, PAT09: Middle Name

String initials initials

The first letter of each part of a proper name. This property stores the initials of a person's name, which is used in research studies to identify the patient without divulging the person's entire name.

String prefix prefix

"Contains a set of honorific terms that typically appear before a person's name, for example Mr., Mrs., Dr., etc. Prefixes have a strong association to the immediately following name part." - HL7 V3
"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." - HL7 FHIR, HumanName.prefix.
"Patient’s name prefix such as Mr. or Dr." - ASAP Standard for PDMP, PAT10: Name Prefix

String suffix suffix

"Contains a list of honorific terms that typically appear after a person's name, for example Jr., Sr., MD, RN, etc. Prefixes have a strong association to the immediately following name part." - HL7 V3
"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." - HL7 FHIR, HumanName.suffix.
"Patient’s name suffix such as Jr. or the III." - ASAP Standard for PDMP, PAT11: Name Suffix

«CS» Code use use

"Identifies the purpose for this name." - HL7 FHIR, HumanName.use.


Properties:

Alias
Classifier Behavior
Is Abstractfalse
Is Activefalse
Is Leaffalse
KeywordsPN
NamePersonName
Name Expression
NamespaceDatatypes
Owned Template Signature
OwnerDatatypes
Owning Template Parameter
PackageDatatypes
Qualified NameFHIM::Datatypes::PersonName
Representation
Stereotype
Template Parameter
VisibilityPublic

Attribute Details

 effectiveDateRange
Public «IVL_TS» Period effectiveDateRange

"Indicates the period of time when this name was valid for the named person." - HL7 FHIR, HumanName.period.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«PN» PersonName
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NameeffectiveDateRange
Name Expression
Namespace«PN» PersonName
Opposite
Owner«PN» PersonName
Owning Association
Owning Template Parameter
Qualified NameFHIM::Datatypes::PersonName::effectiveDateRange
Stereotype
Template Parameter
Type«IVL_TS» Period
Upper1
Upper Value(1)
VisibilityPublic


 family
Public String family

"The portion of a person's name that reflects the genealogy of the person. In western cultures, this is the 'last' name. In eastern cultures, the family name appears before the person's given name(s). In some cultures (e.g. Eritrea) the family name of a son is the first name of his father." - HL7 V3
"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." - HL7 FHIR, HumanName.family.
"Patient’s last name." - ASAP Standard for PDMP, PAT07: Last Name

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«PN» PersonName
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
Namefamily
Name Expression
Namespace«PN» PersonName
Opposite
Owner«PN» PersonName
Owning Association
Owning Template Parameter
Qualified NameFHIM::Datatypes::PersonName::family
Stereotype
Template Parameter
TypeString
Upper*
Upper Value(*)
VisibilityPublic


 given
Public String given

"A set of names given to a person at birth, but not including the family name. In western cultures, this property would contain the 'first' and 'middle' names. Note that in some cultures, the given name is placed after the family name. Note also that this property contains multiple elements, so it can handle those situations where a person has more than one 'middle' name." - HL7 V3
"Given name." - HL7 FHIR, HumanName.given.
"Patient’s first name." - ASAP Standard for PDMP, PAT08: First Name
"Patient’s middle name or initial if available.
Used if available in pharmacy system and required by the PDMP." - ASAP Standard for PDMP, PAT09: Middle Name

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«PN» PersonName
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedtrue
Is Read Onlyfalse
Is Staticfalse
Is Uniquefalse
Keywords
Lower0
Lower Value(0)
Multiplicity*
Namegiven
Name Expression
Namespace«PN» PersonName
Opposite
Owner«PN» PersonName
Owning Association
Owning Template Parameter
Qualified NameFHIM::Datatypes::PersonName::given
Stereotype
Template Parameter
TypeString
Upper*
Upper Value(*)
VisibilityPublic


 initials
Public String initials

The first letter of each part of a proper name. This property stores the initials of a person's name, which is used in research studies to identify the patient without divulging the person's entire name.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«PN» PersonName
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Nameinitials
Name Expression
Namespace«PN» PersonName
Opposite
Owner«PN» PersonName
Owning Association
Owning Template Parameter
Qualified NameFHIM::Datatypes::PersonName::initials
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 prefix
Public String prefix

"Contains a set of honorific terms that typically appear before a person's name, for example Mr., Mrs., Dr., etc. Prefixes have a strong association to the immediately following name part." - HL7 V3
"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." - HL7 FHIR, HumanName.prefix.
"Patient’s name prefix such as Mr. or Dr." - ASAP Standard for PDMP, PAT10: Name Prefix

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«PN» PersonName
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedtrue
Is Read Onlyfalse
Is Staticfalse
Is Uniquefalse
Keywords
Lower0
Lower Value(0)
Multiplicity*
Nameprefix
Name Expression
Namespace«PN» PersonName
Opposite
Owner«PN» PersonName
Owning Association
Owning Template Parameter
Qualified NameFHIM::Datatypes::PersonName::prefix
Stereotype
Template Parameter
TypeString
Upper*
Upper Value(*)
VisibilityPublic


 suffix
Public String suffix

"Contains a list of honorific terms that typically appear after a person's name, for example Jr., Sr., MD, RN, etc. Prefixes have a strong association to the immediately following name part." - HL7 V3
"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." - HL7 FHIR, HumanName.suffix.
"Patient’s name suffix such as Jr. or the III." - ASAP Standard for PDMP, PAT11: Name Suffix

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«PN» PersonName
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedtrue
Is Read Onlyfalse
Is Staticfalse
Is Uniquefalse
Keywords
Lower0
Lower Value(0)
Multiplicity*
Namesuffix
Name Expression
Namespace«PN» PersonName
Opposite
Owner«PN» PersonName
Owning Association
Owning Template Parameter
Qualified NameFHIM::Datatypes::PersonName::suffix
Stereotype
Template Parameter
TypeString
Upper*
Upper Value(*)
VisibilityPublic


 use
Public «CS» Code use

"Identifies the purpose for this name." - HL7 FHIR, HumanName.use.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«PN» PersonName
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Nameuse
Name Expression
Namespace«PN» PersonName
Opposite
Owner«PN» PersonName
Owning Association
Owning Template Parameter
Qualified NameFHIM::Datatypes::PersonName::use
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic

Comments