Skip to main content

HS.FHIR.vSTU3.Model.Base.HumanName

deprecated class HS.FHIR.vSTU3.Model.Base.HumanName extends HS.FHIR.vSTU3.Model.Base.Element

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
A human's name with the ability to identify parts and usage.
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions

Property Inventory

Method Inventory

Parameters

parameter ELEMENTQUALIFIED = 1;
Inherited description: ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute. NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.
parameter JSONTYPEFIELD;
Inherited description: Type property name for JSON export.
parameter XMLNAME = HumanName;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.
parameter XMLSEQUENCE = 1;
Inherited description: If the XMLSEQUENCE = 1, then the order of the XML elements must match the order of the class properties. This allows us to deal with XML where the same field appears multiple times and is distinguished by the order.

Properties

property family as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "family", XMLPROJECTION = "ELEMENT");
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: familyGet(), familyGetSwizzled(), familyIsValid(), familyNewObject(), familySet()
property given as list of HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "given", XMLPROJECTION = "ELEMENT");
Given name.
Property methods: givenBuildValueArray(), givenCollectionToDisplay(), givenCollectionToOdbc(), givenDisplayToCollection(), givenGet(), givenGetObject(), givenGetObjectId(), givenGetSwizzled(), givenIsValid(), givenOdbcToCollection(), givenSet(), givenSetObject(), givenSetObjectId()
property period as HS.FHIR.vSTU3.Model.Base.Period (XMLNAME = "period", XMLPROJECTION = "ELEMENT");
Indicates the period of time when this name was valid for the named person.
Property methods: periodGet(), periodGetSwizzled(), periodIsValid(), periodNewObject(), periodSet()
property prefix as list of HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "prefix", XMLPROJECTION = "ELEMENT");
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: prefixBuildValueArray(), prefixCollectionToDisplay(), prefixCollectionToOdbc(), prefixDisplayToCollection(), prefixGet(), prefixGetObject(), prefixGetObjectId(), prefixGetSwizzled(), prefixIsValid(), prefixOdbcToCollection(), prefixSet(), prefixSetObject(), prefixSetObjectId()
property suffix as list of HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "suffix", XMLPROJECTION = "ELEMENT");
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: suffixBuildValueArray(), suffixCollectionToDisplay(), suffixCollectionToOdbc(), suffixDisplayToCollection(), suffixGet(), suffixGetObject(), suffixGetObjectId(), suffixGetSwizzled(), suffixIsValid(), suffixOdbcToCollection(), suffixSet(), suffixSetObject(), suffixSetObjectId()
property text as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "text", XMLPROJECTION = "ELEMENT");
A full text representation of the name.
Property methods: textGet(), textGetSwizzled(), textIsValid(), textNewObject(), textSet()
property use as HS.FHIR.vSTU3.Model.Base.NameUse (XMLNAME = "use", XMLPROJECTION = "ELEMENT");
Identifies the purpose for this name.
Property methods: useGet(), useGetSwizzled(), useIsValid(), useNewObject(), useSet()

Methods

deprecated method %OnNew(pLastName As %String, pFirstName As %String, pMiddleName As %String, pPrefix As %String, pSuffix As %String, pUse As %String, pText As %String, pStart As %String, pEnd As %String, pId As %String, pExtension As %RegisteredObject) as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Get new object, populated with specified data.
deprecated method SetFamily(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "family" property.
deprecated method SetGiven(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "given" property.
deprecated method SetPeriod(pStart As %String = "", pEnd As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "period" property.
deprecated method SetPrefix(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "prefix" property.
deprecated method SetSuffix(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "suffix" property.
deprecated method SetText(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "text" property.
deprecated method SetUse(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "use" property.

Inherited Members

Inherited Properties

Inherited Methods

Feedback