Skip to main content

HS.FHIR.vSTU3.Model.Resource.Patient

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

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Demographics and other administrative information about an individual or animal receiving care or other health-related services.
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 = Patient;
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 patient 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");
Addresses for the individual.
Property methods: addressBuildValueArray(), addressCollectionToDisplay(), addressCollectionToOdbc(), addressDisplayToCollection(), addressGet(), addressGetObject(), addressGetObjectId(), addressGetSwizzled(), addressIsValid(), addressOdbcToCollection(), addressSet(), addressSetObject(), addressSetObjectId()
property animal as HS.FHIR.vSTU3.Model.Resource.Patient.Animal (XMLNAME = "animal", XMLPROJECTION = "ELEMENT");
This patient is known to be an animal.
Property methods: animalGet(), animalGetSwizzled(), animalIsValid(), animalNewObject(), animalSet()
property birthDate as HS.FHIR.vSTU3.Model.Datatype.Date (XMLNAME = "birthDate", XMLPROJECTION = "ELEMENT");
The date of birth for the individual.
Property methods: birthDateGet(), birthDateGetSwizzled(), birthDateIsValid(), birthDateNewObject(), birthDateSet()
property communication as list of HS.FHIR.vSTU3.Model.Resource.Patient.Communication (XMLNAME = "communication", XMLPROJECTION = "ELEMENT");
Languages which may be used to communicate with the patient about his or her health.
Property methods: communicationBuildValueArray(), communicationCollectionToDisplay(), communicationCollectionToOdbc(), communicationDisplayToCollection(), communicationGet(), communicationGetObject(), communicationGetObjectId(), communicationGetSwizzled(), communicationIsValid(), communicationOdbcToCollection(), communicationSet(), communicationSetObject(), communicationSetObjectId()
property contact as list of HS.FHIR.vSTU3.Model.Resource.Patient.Contact (XMLNAME = "contact", XMLPROJECTION = "ELEMENT");
A contact party (e.g. guardian, partner, friend) for the patient.
Property methods: contactBuildValueArray(), contactCollectionToDisplay(), contactCollectionToOdbc(), contactDisplayToCollection(), contactGet(), contactGetObject(), contactGetObjectId(), contactGetSwizzled(), contactIsValid(), contactOdbcToCollection(), contactSet(), contactSetObject(), contactSetObjectId()
property deceasedBoolean as HS.FHIR.vSTU3.Model.Datatype.Boolean (XMLNAME = "deceasedBoolean", XMLPROJECTION = "ELEMENT");
Property methods: deceasedBooleanGet(), deceasedBooleanGetSwizzled(), deceasedBooleanIsValid(), deceasedBooleanNewObject(), deceasedBooleanSet()
property deceasedDateTime as HS.FHIR.vSTU3.Model.Datatype.DateTime (XMLNAME = "deceasedDateTime", XMLPROJECTION = "ELEMENT");
Property methods: deceasedDateTimeGet(), deceasedDateTimeGetSwizzled(), deceasedDateTimeIsValid(), deceasedDateTimeNewObject(), deceasedDateTimeSet()
property gender as HS.FHIR.vSTU3.Model.Base.AdministrativeGender (XMLNAME = "gender", XMLPROJECTION = "ELEMENT");
Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.
Property methods: genderGet(), genderGetSwizzled(), genderIsValid(), genderNewObject(), genderSet()
property generalPractitioner as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "generalPractitioner", XMLPROJECTION = "ELEMENT");
Patient's nominated care provider.
Property methods: generalPractitionerBuildValueArray(), generalPractitionerCollectionToDisplay(), generalPractitionerCollectionToOdbc(), generalPractitionerDisplayToCollection(), generalPractitionerGet(), generalPractitionerGetObject(), generalPractitionerGetObjectId(), generalPractitionerGetSwizzled(), generalPractitionerIsValid(), generalPractitionerOdbcToCollection(), generalPractitionerSet(), generalPractitionerSetObject(), generalPractitionerSetObjectId()
property identifier as list of HS.FHIR.vSTU3.Model.Base.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
An identifier for this patient.
Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
Link to another patient resource that concerns the same actual patient.
Property methods: linkBuildValueArray(), linkCollectionToDisplay(), linkCollectionToOdbc(), linkDisplayToCollection(), linkGet(), linkGetObject(), linkGetObjectId(), linkGetSwizzled(), linkIsValid(), linkOdbcToCollection(), linkSet(), linkSetObject(), linkSetObjectId()
property managingOrganization as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "managingOrganization", XMLPROJECTION = "ELEMENT");
Organization that is the custodian of the patient record.
Property methods: managingOrganizationGet(), managingOrganizationGetSwizzled(), managingOrganizationIsValid(), managingOrganizationNewObject(), managingOrganizationSet()
property maritalStatus as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "maritalStatus", XMLPROJECTION = "ELEMENT");
This field contains a patient's most recent marital (civil) status.
Property methods: maritalStatusGet(), maritalStatusGetSwizzled(), maritalStatusIsValid(), maritalStatusNewObject(), maritalStatusSet()
property multipleBirthBoolean as HS.FHIR.vSTU3.Model.Datatype.Boolean (XMLNAME = "multipleBirthBoolean", XMLPROJECTION = "ELEMENT");
Property methods: multipleBirthBooleanGet(), multipleBirthBooleanGetSwizzled(), multipleBirthBooleanIsValid(), multipleBirthBooleanNewObject(), multipleBirthBooleanSet()
property multipleBirthInteger as HS.FHIR.vSTU3.Model.Datatype.Integer (XMLNAME = "multipleBirthInteger", XMLPROJECTION = "ELEMENT");
Property methods: multipleBirthIntegerGet(), multipleBirthIntegerGetSwizzled(), multipleBirthIntegerIsValid(), multipleBirthIntegerNewObject(), multipleBirthIntegerSet()
property name as list of HS.FHIR.vSTU3.Model.Base.HumanName (XMLNAME = "name", XMLPROJECTION = "ELEMENT");
A name associated with the individual.
Property methods: nameBuildValueArray(), nameCollectionToDisplay(), nameCollectionToOdbc(), nameDisplayToCollection(), nameGet(), nameGetObject(), nameGetObjectId(), nameGetSwizzled(), nameIsValid(), nameOdbcToCollection(), nameSet(), nameSetObject(), nameSetObjectId()
property photo as list of HS.FHIR.vSTU3.Model.Base.Attachment (XMLNAME = "photo", XMLPROJECTION = "ELEMENT");
Image of the patient.
Property methods: photoBuildValueArray(), photoCollectionToDisplay(), photoCollectionToOdbc(), photoDisplayToCollection(), photoGet(), photoGetObject(), photoGetObjectId(), photoGetSwizzled(), photoIsValid(), photoOdbcToCollection(), photoSet(), photoSetObject(), photoSetObjectId()
property telecom as list of HS.FHIR.vSTU3.Model.Base.ContactPoint (XMLNAME = "telecom", XMLPROJECTION = "ELEMENT");
A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.
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 SetDeceasedBoolean(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 "deceasedBoolean" property.
deprecated method SetDeceasedDateTime(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 "deceasedDateTime" 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 SetGeneralPractitioner(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "generalPractitioner" 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.
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "link" property.
deprecated method SetManagingOrganization(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 "managingOrganization" property.
deprecated method SetMaritalStatus(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 "maritalStatus" property.
deprecated method SetMultipleBirthBoolean(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 "multipleBirthBoolean" property.
deprecated method SetMultipleBirthInteger(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 "multipleBirthInteger" 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 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 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