HS.FHIRModel.R4.HumanName
class HS.FHIRModel.R4.HumanName extends HS.FHIRModel.FHIRClassSuper
******************************************* HumanName generated class schema
*****************************************
A human's name with the ability to identify parts and usage.
Property Inventory
- _family
- _given
- _prefix
- _suffix
- _text
- _use
- extension
- family
- fhirID
- given
- period
- prefix
- suffix
- text
- use
Method Inventory
- IncludeExtension()
- IncludeGiven()
- IncludePeriod()
- IncludePrefix()
- IncludeSuffix()
- _getProperties()
- fromDao()
- toDao()
Parameters
parameter XMLTYPE = R4_HUMANNAME;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is
empty then the class name will be used to construct a default XML type.
The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.
Properties
property _family as HS.FHIRModel.R4.Element;
Extensions for family
Property methods: _familyGet(), _familyGetSwizzled(), _familyIsValid(), _familyNewObject(), _familySet()
property _given as HS.FHIRModel.R4.SeqOfElement;
Extensions for given
Property methods: _givenGet(), _givenGetSwizzled(), _givenIsValid(), _givenNewObject(), _givenSet()
property _prefix as HS.FHIRModel.R4.SeqOfElement;
Extensions for prefix
Property methods: _prefixGet(), _prefixGetSwizzled(), _prefixIsValid(), _prefixNewObject(), _prefixSet()
property _suffix as HS.FHIRModel.R4.SeqOfElement;
Extensions for suffix
Property methods: _suffixGet(), _suffixGetSwizzled(), _suffixIsValid(), _suffixNewObject(), _suffixSet()
property _text as HS.FHIRModel.R4.Element;
Extensions for text
Property methods: _textGet(), _textGetSwizzled(), _textIsValid(), _textNewObject(), _textSet()
property _use as HS.FHIRModel.R4.Element;
Extensions for use
Property methods: _useGet(), _useGetSwizzled(), _useIsValid(), _useNewObject(), _useSet()
property extension as HS.FHIRModel.R4.SeqOfExtension;
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 manageable, 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.
Property methods: extensionGet(), extensionGetSwizzled(), extensionIsValid(), extensionNewObject(), extensionSet()
property family as %String;
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.
Property methods: familyDisplayToLogical(), familyGet(), familyIsValid(), familyLogicalToDisplay(), familyLogicalToOdbc(), familyNormalize(), familySet()
property fhirID as %String;
Unique id for the element within a resource (for internal references).
This may be any string value that does not contain spaces.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
property given as HS.FHIRModel.R4.SeqOfString;
Given name.
Property methods: givenGet(), givenGetSwizzled(), givenIsValid(), givenNewObject(), givenSet()
property period as HS.FHIRModel.R4.Period;
Indicates the period of time when this name was valid for the named
person.
Property methods: periodGet(), periodGetSwizzled(), periodIsValid(), periodNewObject(), periodSet()
property prefix as HS.FHIRModel.R4.SeqOfString;
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.
Property methods: prefixGet(), prefixGetSwizzled(), prefixIsValid(), prefixNewObject(), prefixSet()
property suffix as HS.FHIRModel.R4.SeqOfString;
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.
Property methods: suffixGet(), suffixGetSwizzled(), suffixIsValid(), suffixNewObject(), suffixSet()
property text as %String;
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.
Property methods: textDisplayToLogical(), textGet(), textIsValid(), textLogicalToDisplay(), textLogicalToOdbc(), textNormalize(), textSet()
property use as %String (VALUELIST = ",usual,official,temp,nickname,anonymous,old,maiden");
Identifies the purpose for this name.
Property methods: useDisplayToLogical(), useGet(), useIsValid(), useLogicalToDisplay(), useLogicalToOdbc(), useNormalize(), useSet()
Methods
method IncludeExtension()
method IncludeGiven()
method IncludePeriod()
method IncludePrefix()
method IncludeSuffix()
method _getProperties() as %DynamicArray
Inherited description: Return an array of the defined properties of this class
in the definition order that they were discovered in the
the HL7FHIR JSchema document
classmethod fromDao(dao As %Library.DynamicAbstractObject) as HS.FHIRModel.R4.HumanName
method toDao() as %DynamicAbstractObject
Inherited description: >
The toDao() method casts the set to a DAO.
Inherited Members
Inherited Methods
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ValidateObject()
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLNew()
- XMLSchema()
- XMLSchemaNamespace()
- XMLSchemaType()
- add()
- addAll()
- apply()
- clear()
- contains()
- containsAll()
- get()
- iterator()
- put()
- putAll()
- putAllIfAbsent()
- putIfAbsent()
- remove()
- removeAll()
- removeIf()
- rename()
- replace()
- replaceAll()
- size()
- toString()