Skip to main content


class HS.FHIR.DTL.vR4.Model.Resource.RelatedPerson extends HS.FHIR.DTL.vR4.Model.Base.DomainResource

A person that is related to a patient, but who is not a direct target of care.

Property Inventory


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.
parameter XMLTYPE = RelatedPerson;
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.


property active as %Boolean (XMLNAME = "active", XMLPROJECTION = "ATTRIBUTE");

Whether this related person's record is in active use.

Property methods: activeDisplayToLogical(), activeGet(), activeIsValid(), activeLogicalToDisplay(), activeLogicalToXSD(), activeNormalize(), activeSet(), activeXSDToLogical()
property address as list of HS.FHIR.DTL.vR4.Model.Datatype.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 %String (MAXLEN = 1000000, XMLNAME = "birthDate", XMLPROJECTION = "ATTRIBUTE");

The date on which the related person was born.

Property methods: birthDateDisplayToLogical(), birthDateGet(), birthDateIsValid(), birthDateLogicalToDisplay(), birthDateLogicalToOdbc(), birthDateNormalize(), birthDateSet()
property communication as list of HS.FHIR.DTL.vR4.Model.Element.RelatedPerson.communication (XMLNAME = "communication", XMLPROJECTION = "ELEMENT");

A language which may be used to communicate with about the patient's health.

Property methods: communicationBuildValueArray(), communicationCollectionToDisplay(), communicationCollectionToOdbc(), communicationDisplayToCollection(), communicationGet(), communicationGetObject(), communicationGetObjectId(), communicationGetSwizzled(), communicationIsValid(), communicationOdbcToCollection(), communicationSet(), communicationSetObject(), communicationSetObjectId()
property gender as %String (MAXLEN = 1000000, XMLNAME = "gender", XMLPROJECTION = "ATTRIBUTE");

male | female | other | unknown

administrative-gender|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend administrative-gender|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: genderDisplayToLogical(), genderGet(), genderIsValid(), genderLogicalToDisplay(), genderLogicalToOdbc(), genderNormalize(), genderSet()
property identifier as list of HS.FHIR.DTL.vR4.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");

A human identifier for this person.

Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property name as list of HS.FHIR.DTL.vR4.Model.Datatype.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.DTL.vR4.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.DTL.vR4.Model.Datatype.Period (XMLNAME = "period", XMLPROJECTION = "ELEMENT");

Period of time that this relationship is considered valid.

Property methods: periodGet(), periodGetSwizzled(), periodIsValid(), periodNewObject(), periodSet()
property photo as list of HS.FHIR.DTL.vR4.Model.Datatype.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 list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "relationship", XMLPROJECTION = "ELEMENT");

The nature of the relationship.

relatedperson-relationshiptype is the PREFERRED FHIR4 ValueSet for codes, but if you need to express meanings not found in relatedperson-relationshiptype, you may use codes from any ValueSet.

Property methods: relationshipBuildValueArray(), relationshipCollectionToDisplay(), relationshipCollectionToOdbc(), relationshipDisplayToCollection(), relationshipGet(), relationshipGetObject(), relationshipGetObjectId(), relationshipGetSwizzled(), relationshipIsValid(), relationshipOdbcToCollection(), relationshipSet(), relationshipSetObject(), relationshipSetObjectId()
property telecom as list of HS.FHIR.DTL.vR4.Model.Datatype.ContactPoint (XMLNAME = "telecom", XMLPROJECTION = "ELEMENT");

A contact detail for the person.

Property methods: telecomBuildValueArray(), telecomCollectionToDisplay(), telecomCollectionToOdbc(), telecomDisplayToCollection(), telecomGet(), telecomGetObject(), telecomGetObjectId(), telecomGetSwizzled(), telecomIsValid(), telecomOdbcToCollection(), telecomSet(), telecomSetObject(), telecomSetObjectId()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab