Skip to main content

HS.FHIR.vSTU3.Model.Resource.RelatedPerson

deprecated class HS.FHIR.vSTU3.Model.Resource.RelatedPerson extends HS.FHIR.vSTU3.Model.Base.DomainResource

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.
If the element is present, it must have either a @value, an @id, 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 XMLNAME = RelatedPerson;
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 active as HS.FHIR.vSTU3.Model.Datatype.Boolean (XMLNAME = "active", XMLPROJECTION = "ELEMENT");
Whether this related person record is in active use.
Property methods: activeGet(), activeGetSwizzled(), activeIsValid(), activeNewObject(), activeSet()
property address as list of HS.FHIR.vSTU3.Model.Base.Address (XMLNAME = "address", XMLPROJECTION = "ELEMENT");
Address where the related person can be contacted or visited.
Property methods: addressBuildValueArray(), addressCollectionToDisplay(), addressCollectionToOdbc(), addressDisplayToCollection(), addressGet(), addressGetObject(), addressGetObjectId(), addressGetSwizzled(), addressIsValid(), addressOdbcToCollection(), addressSet(), addressSetObject(), addressSetObjectId()
property birthDate as HS.FHIR.vSTU3.Model.Datatype.Date (XMLNAME = "birthDate", XMLPROJECTION = "ELEMENT");
The date on which the related person was born.
Property methods: birthDateGet(), birthDateGetSwizzled(), birthDateIsValid(), birthDateNewObject(), birthDateSet()
property gender as HS.FHIR.vSTU3.Model.Base.AdministrativeGender (XMLNAME = "gender", XMLPROJECTION = "ELEMENT");
Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
Property methods: genderGet(), genderGetSwizzled(), genderIsValid(), genderNewObject(), genderSet()
property identifier as list of HS.FHIR.vSTU3.Model.Base.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
Identifier for a person within a particular scope.
Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property name as list of HS.FHIR.vSTU3.Model.Base.HumanName (XMLNAME = "name", XMLPROJECTION = "ELEMENT");
A name associated with the person.
Property methods: nameBuildValueArray(), nameCollectionToDisplay(), nameCollectionToOdbc(), nameDisplayToCollection(), nameGet(), nameGetObject(), nameGetObjectId(), nameGetSwizzled(), nameIsValid(), nameOdbcToCollection(), nameSet(), nameSetObject(), nameSetObjectId()
property patient as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "patient", XMLPROJECTION = "ELEMENT") [ Required ];
The patient this person is related to.
Property methods: patientGet(), patientGetSwizzled(), patientIsValid(), patientNewObject(), patientSet()
property period as HS.FHIR.vSTU3.Model.Base.Period (XMLNAME = "period", XMLPROJECTION = "ELEMENT");
The period of time that this relationship is considered to be valid. If there are no dates defined, then the interval is unknown.
Property methods: periodGet(), periodGetSwizzled(), periodIsValid(), periodNewObject(), periodSet()
property photo as list of HS.FHIR.vSTU3.Model.Base.Attachment (XMLNAME = "photo", XMLPROJECTION = "ELEMENT");
Image of the person.
Property methods: photoBuildValueArray(), photoCollectionToDisplay(), photoCollectionToOdbc(), photoDisplayToCollection(), photoGet(), photoGetObject(), photoGetObjectId(), photoGetSwizzled(), photoIsValid(), photoOdbcToCollection(), photoSet(), photoSetObject(), photoSetObjectId()
property relationship as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "relationship", XMLPROJECTION = "ELEMENT");
The nature of the relationship between a patient and the related person.
Property methods: relationshipGet(), relationshipGetSwizzled(), relationshipIsValid(), relationshipNewObject(), relationshipSet()
property telecom as list of HS.FHIR.vSTU3.Model.Base.ContactPoint (XMLNAME = "telecom", XMLPROJECTION = "ELEMENT");
A contact detail for the person, e.g. a telephone number or an email address.
Property methods: telecomBuildValueArray(), telecomCollectionToDisplay(), telecomCollectionToOdbc(), telecomDisplayToCollection(), telecomGet(), telecomGetObject(), telecomGetObjectId(), telecomGetSwizzled(), telecomIsValid(), telecomOdbcToCollection(), telecomSet(), telecomSetObject(), telecomSetObjectId()

Methods

deprecated method SetActive(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 "active" property.
deprecated method SetBirthDate(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 "birthDate" property.
deprecated method SetGender(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 "gender" property.
deprecated method SetIdentifier(pValue As %String = "", pSystem As %String = "", pUse As %String = "", pTypeCode As %String = "", pTypeSystem As %String = "", pTypeDisplay As %String = "", pTypeText As %String = "", pId As %String = "", pStart As %String = "", pEnd As %String = "", pAssignerReference As %String = "", pAssignerDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "identifier" property.
deprecated method SetName(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.
Insert method for the "name" property.
deprecated method SetPatient(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "patient" 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 SetPhoto(pContentType As %String = "", pLanguage As %String = "", pData As %String = "", pUrl As %String = "", pSize As %String = "", pHash As %String = "", pTitle As %String = "", pCreation As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "photo" property.
deprecated method SetRelationship(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "relationship" property.
deprecated method SetTelecom(pValue As %String = "", pSystem As %String = "", pUse As %String = "", pRank As %String = "", pStart As %String = "", pEnd As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "telecom" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab