Skip to main content

HS.FHIR.DTL.vR4.Model.Resource.Patient

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

Information about an individual or animal receiving health care services.

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 = 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 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 = Patient;
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 active as %Boolean (XMLNAME = "active", XMLPROJECTION = "ATTRIBUTE");
boolean

Whether this patient'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

An address for the individual.

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");
date

The date of birth for the individual.

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

A language 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.DTL.vR4.Model.Element.Patient.contact (XMLNAME = "contact", XMLPROJECTION = "ELEMENT");
BackboneElement

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 %Boolean (XMLNAME = "deceasedBoolean", XMLPROJECTION = "ATTRIBUTE");
boolean

Indicates if the individual is deceased or not.

Property methods: deceasedBooleanDisplayToLogical(), deceasedBooleanGet(), deceasedBooleanIsValid(), deceasedBooleanLogicalToDisplay(), deceasedBooleanLogicalToXSD(), deceasedBooleanNormalize(), deceasedBooleanSet(), deceasedBooleanXSDToLogical()
property deceasedDateTime as %String (MAXLEN = 1000000, XMLNAME = "deceasedDateTime", XMLPROJECTION = "ATTRIBUTE");
dateTime

Indicates if the individual is deceased or not.

Property methods: deceasedDateTimeDisplayToLogical(), deceasedDateTimeGet(), deceasedDateTimeIsValid(), deceasedDateTimeLogicalToDisplay(), deceasedDateTimeLogicalToOdbc(), deceasedDateTimeNormalize(), deceasedDateTimeSet()
property gender as %String (MAXLEN = 1000000, XMLNAME = "gender", XMLPROJECTION = "ATTRIBUTE");
code

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 generalPractitioner as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "generalPractitioner", XMLPROJECTION = "ELEMENT");
Reference

Patient's nominated primary care provider.

Organization | Practitioner | PractitionerRole

Property methods: generalPractitionerBuildValueArray(), generalPractitionerCollectionToDisplay(), generalPractitionerCollectionToOdbc(), generalPractitionerDisplayToCollection(), generalPractitionerGet(), generalPractitionerGetObject(), generalPractitionerGetObjectId(), generalPractitionerGetSwizzled(), generalPractitionerIsValid(), generalPractitionerOdbcToCollection(), generalPractitionerSet(), generalPractitionerSetObject(), generalPractitionerSetObjectId()
property identifier as list of HS.FHIR.DTL.vR4.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
Identifier

An identifier for this patient.

Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
BackboneElement

Link to another patient resource that concerns the same actual person.

Property methods: linkBuildValueArray(), linkCollectionToDisplay(), linkCollectionToOdbc(), linkDisplayToCollection(), linkGet(), linkGetObject(), linkGetObjectId(), linkGetSwizzled(), linkIsValid(), linkOdbcToCollection(), linkSet(), linkSetObject(), linkSetObjectId()
property managingOrganization as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "managingOrganization", XMLPROJECTION = "ELEMENT");
Reference

Organization that is the custodian of the patient record.

Organization

Property methods: managingOrganizationGet(), managingOrganizationGetSwizzled(), managingOrganizationIsValid(), managingOrganizationNewObject(), managingOrganizationSet()
property maritalStatus as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "maritalStatus", XMLPROJECTION = "ELEMENT");
CodeableConcept

Marital (civil) status of a patient.

marital-status is the REQUIRED FHIR4 ValueSet for codes, but if you need to express meanings not found in marital-status, you may formally EXTEND marital-status to add codes to it.

Property methods: maritalStatusGet(), maritalStatusGetSwizzled(), maritalStatusIsValid(), maritalStatusNewObject(), maritalStatusSet()
property multipleBirthBoolean as %Boolean (XMLNAME = "multipleBirthBoolean", XMLPROJECTION = "ATTRIBUTE");
boolean

Whether patient is part of a multiple birth.

Property methods: multipleBirthBooleanDisplayToLogical(), multipleBirthBooleanGet(), multipleBirthBooleanIsValid(), multipleBirthBooleanLogicalToDisplay(), multipleBirthBooleanLogicalToXSD(), multipleBirthBooleanNormalize(), multipleBirthBooleanSet(), multipleBirthBooleanXSDToLogical()
property multipleBirthInteger as %Integer (XMLNAME = "multipleBirthInteger", XMLPROJECTION = "ATTRIBUTE");
integer

Whether patient is part of a multiple birth.

Property methods: multipleBirthIntegerDisplayToLogical(), multipleBirthIntegerGet(), multipleBirthIntegerIsValid(), multipleBirthIntegerLogicalToDisplay(), multipleBirthIntegerNormalize(), multipleBirthIntegerSet(), multipleBirthIntegerXSDToLogical()
property name as list of HS.FHIR.DTL.vR4.Model.Datatype.HumanName (XMLNAME = "name", XMLPROJECTION = "ELEMENT");
HumanName

A name associated with the patient.

Property methods: nameBuildValueArray(), nameCollectionToDisplay(), nameCollectionToOdbc(), nameDisplayToCollection(), nameGet(), nameGetObject(), nameGetObjectId(), nameGetSwizzled(), nameIsValid(), nameOdbcToCollection(), nameSet(), nameSetObject(), nameSetObjectId()
property photo as list of HS.FHIR.DTL.vR4.Model.Datatype.Attachment (XMLNAME = "photo", XMLPROJECTION = "ELEMENT");
Attachment

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.DTL.vR4.Model.Datatype.ContactPoint (XMLNAME = "telecom", XMLPROJECTION = "ELEMENT");
ContactPoint

A contact detail for the individual.

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