HS.FHIR.DTL.vR4.Model.Datatype.HumanName
class HS.FHIR.DTL.vR4.Model.Datatype.HumanName extends HS.FHIR.DTL.vR4.Model.Base.Element
Name of a human - parts and usage.Property 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 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 XMLPROJECTION = ELEMENT;
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.
parameter XMLTYPE = 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 %String (MAXLEN = 1000000, XMLNAME = "family", XMLPROJECTION = "ATTRIBUTE");
string
Family name (often called 'Surname')
Property methods: familyDisplayToLogical(), familyGet(), familyIsValid(), familyLogicalToDisplay(), familyLogicalToOdbc(), familyNormalize(), familySet()
property given as list of %String (MAXLEN = 1000000, XMLNAME = "given", XMLPROJECTION = "ELEMENT");
string
Given names (not always 'first'). Includes middle names.
Property methods: givenBuildValueArray(), givenCollectionToDisplay(), givenCollectionToOdbc(), givenDisplayToCollection(), givenDisplayToLogical(), givenGet(), givenGetObject(), givenGetObjectId(), givenGetSwizzled(), givenIsValid(), givenLogicalToDisplay(), givenLogicalToOdbc(), givenNormalize(), givenOdbcToCollection(), givenSet(), givenSetObject(), givenSetObjectId()
property period as HS.FHIR.DTL.vR4.Model.Datatype.Period (XMLNAME = "period", XMLPROJECTION = "ELEMENT");
Period
Time period when name was/is in use.
Property methods: periodGet(), periodGetSwizzled(), periodIsValid(), periodNewObject(), periodSet()
property prefix as list of %String (MAXLEN = 1000000, XMLNAME = "prefix", XMLPROJECTION = "ELEMENT");
string
Parts that come before the name.
Property methods: prefixBuildValueArray(), prefixCollectionToDisplay(), prefixCollectionToOdbc(), prefixDisplayToCollection(), prefixDisplayToLogical(), prefixGet(), prefixGetObject(), prefixGetObjectId(), prefixGetSwizzled(), prefixIsValid(), prefixLogicalToDisplay(), prefixLogicalToOdbc(), prefixNormalize(), prefixOdbcToCollection(), prefixSet(), prefixSetObject(), prefixSetObjectId()
property suffix as list of %String (MAXLEN = 1000000, XMLNAME = "suffix", XMLPROJECTION = "ELEMENT");
string
Parts that come after the name.
Property methods: suffixBuildValueArray(), suffixCollectionToDisplay(), suffixCollectionToOdbc(), suffixDisplayToCollection(), suffixDisplayToLogical(), suffixGet(), suffixGetObject(), suffixGetObjectId(), suffixGetSwizzled(), suffixIsValid(), suffixLogicalToDisplay(), suffixLogicalToOdbc(), suffixNormalize(), suffixOdbcToCollection(), suffixSet(), suffixSetObject(), suffixSetObjectId()
property text as %String (MAXLEN = 1000000, XMLNAME = "text", XMLPROJECTION = "ATTRIBUTE");
string
Text representation of the full name.
Property methods: textDisplayToLogical(), textGet(), textIsValid(), textLogicalToDisplay(), textLogicalToOdbc(), textNormalize(), textSet()
property use as %String (MAXLEN = 1000000, XMLNAME = "use", XMLPROJECTION = "ATTRIBUTE");
code
usual | official | temp | nickname | anonymous | old | maiden
name-use|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend name-use|4.0.1 and you may NOT use codes from other ValueSets.
Property methods: useDisplayToLogical(), useGet(), useIsValid(), useLogicalToDisplay(), useLogicalToOdbc(), useNormalize(), useSet()
Inherited Members
Inherited Properties
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()
- FromJSON()
- FromJSONDir()
- FromJSONFile()
- FromJSONHelper()
- FromXML()
- FromXMLHelper()
- PrimitiveExtensionHandler()
- ToJSON()
- ToJSONHelper()
- ToXML()
- ToXMLHelper()
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLNew()
- XMLSchema()
- XMLSchemaNamespace()
- XMLSchemaType()