| Datatypes UML Documentation |
Summary:AttributesCommentsProperties | Detail:Attributes |
"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 |
"Indicates the period of time when this name was valid for the named person." - HL7 FHIR, HumanName.period. |
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 |
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 |
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. |
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 |
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 |
«CS» Code | use |
"Identifies the purpose for this name." - HL7 FHIR, HumanName.use. |
Properties:
Alias | |
Classifier Behavior | |
Is Abstract | false |
Is Active | false |
Is Leaf | false |
Keywords | PN |
Name | PersonName |
Name Expression | |
Namespace | Datatypes |
Owned Template Signature | |
Owner | Datatypes |
Owning Template Parameter | |
Package | Datatypes |
Qualified Name | FHIM::Datatypes::PersonName |
Representation | |
Stereotype | |
Template Parameter | |
Visibility | Public |
Attribute Details |
Public «IVL_TS» Period effectiveDateRange
"Indicates the period of time when this name was valid for the named person." - HL7 FHIR, HumanName.period.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «PN» PersonName |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | effectiveDateRange |
Name Expression | |
Namespace | «PN» PersonName |
Opposite | |
Owner | «PN» PersonName |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Datatypes::PersonName::effectiveDateRange |
Stereotype | |
Template Parameter | |
Type | «IVL_TS» Period |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «PN» PersonName |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | family |
Name Expression | |
Namespace | «PN» PersonName |
Opposite | |
Owner | «PN» PersonName |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Datatypes::PersonName::family |
Stereotype | |
Template Parameter | |
Type | String |
Upper | * |
Upper Value | (*) |
Visibility | Public |
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
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «PN» PersonName |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | true |
Is Read Only | false |
Is Static | false |
Is Unique | false |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | given |
Name Expression | |
Namespace | «PN» PersonName |
Opposite | |
Owner | «PN» PersonName |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Datatypes::PersonName::given |
Stereotype | |
Template Parameter | |
Type | String |
Upper | * |
Upper Value | (*) |
Visibility | Public |
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.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «PN» PersonName |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | initials |
Name Expression | |
Namespace | «PN» PersonName |
Opposite | |
Owner | «PN» PersonName |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Datatypes::PersonName::initials |
Stereotype | |
Template Parameter | |
Type | String |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «PN» PersonName |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | true |
Is Read Only | false |
Is Static | false |
Is Unique | false |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | prefix |
Name Expression | |
Namespace | «PN» PersonName |
Opposite | |
Owner | «PN» PersonName |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Datatypes::PersonName::prefix |
Stereotype | |
Template Parameter | |
Type | String |
Upper | * |
Upper Value | (*) |
Visibility | Public |
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
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «PN» PersonName |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | true |
Is Read Only | false |
Is Static | false |
Is Unique | false |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | suffix |
Name Expression | |
Namespace | «PN» PersonName |
Opposite | |
Owner | «PN» PersonName |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Datatypes::PersonName::suffix |
Stereotype | |
Template Parameter | |
Type | String |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public «CS» Code use
"Identifies the purpose for this name." - HL7 FHIR, HumanName.use.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «PN» PersonName |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | use |
Name Expression | |
Namespace | «PN» PersonName |
Opposite | |
Owner | «PN» PersonName |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Datatypes::PersonName::use |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Comments |
| Datatypes UML Documentation |
Summary:AttributesCommentsProperties | Detail:Attributes |