Skip to main content

HS.FHIRModel.R4.Patient

class HS.FHIRModel.R4.Patient extends HS.FHIRModel.FHIRClassSuper

*****************************************
** Patient generated class schema
*****************************************
Demographics and other administrative information about an individual or animal receiving care or other health-related services.

Property Inventory

Method Inventory

Parameters

parameter XMLTYPE = R4_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 HS.FHIRModel.R4.Element;
Extensions for active
Property methods: _activeGet(), _activeGetSwizzled(), _activeIsValid(), _activeNewObject(), _activeSet()
property _birthDate as HS.FHIRModel.R4.Element;
Extensions for birthDate
Property methods: _birthDateGet(), _birthDateGetSwizzled(), _birthDateIsValid(), _birthDateNewObject(), _birthDateSet()
property _deceasedBoolean as HS.FHIRModel.R4.Element;
Extensions for deceasedBoolean
Property methods: _deceasedBooleanGet(), _deceasedBooleanGetSwizzled(), _deceasedBooleanIsValid(), _deceasedBooleanNewObject(), _deceasedBooleanSet()
property _deceasedDateTime as HS.FHIRModel.R4.Element;
Extensions for deceasedDateTime
Property methods: _deceasedDateTimeGet(), _deceasedDateTimeGetSwizzled(), _deceasedDateTimeIsValid(), _deceasedDateTimeNewObject(), _deceasedDateTimeSet()
property _gender as HS.FHIRModel.R4.Element;
Extensions for gender
Property methods: _genderGet(), _genderGetSwizzled(), _genderIsValid(), _genderNewObject(), _genderSet()
property _implicitRules as HS.FHIRModel.R4.Element;
Extensions for implicitRules
Property methods: _implicitRulesGet(), _implicitRulesGetSwizzled(), _implicitRulesIsValid(), _implicitRulesNewObject(), _implicitRulesSet()
property _language as HS.FHIRModel.R4.Element;
Extensions for language
Property methods: _languageGet(), _languageGetSwizzled(), _languageIsValid(), _languageNewObject(), _languageSet()
property _multipleBirthBoolean as HS.FHIRModel.R4.Element;
Extensions for multipleBirthBoolean
Property methods: _multipleBirthBooleanGet(), _multipleBirthBooleanGetSwizzled(), _multipleBirthBooleanIsValid(), _multipleBirthBooleanNewObject(), _multipleBirthBooleanSet()
property _multipleBirthInteger as HS.FHIRModel.R4.Element;
Extensions for multipleBirthInteger
Property methods: _multipleBirthIntegerGet(), _multipleBirthIntegerGetSwizzled(), _multipleBirthIntegerIsValid(), _multipleBirthIntegerNewObject(), _multipleBirthIntegerSet()
property active as %Boolean;
Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules. It is often used to filter patient lists to exclude inactive patients Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.
Property methods: activeDisplayToLogical(), activeGet(), activeIsValid(), activeLogicalToDisplay(), activeLogicalToXSD(), activeNormalize(), activeSet(), activeXSDToLogical()
property address as HS.FHIRModel.R4.SeqOfAddress;
An address for the individual.
Property methods: addressGet(), addressGetSwizzled(), addressIsValid(), addressNewObject(), addressSet()
property birthDate as %String;
The date of birth for the individual.
Property methods: birthDateDisplayToLogical(), birthDateGet(), birthDateIsValid(), birthDateLogicalToDisplay(), birthDateLogicalToOdbc(), birthDateNormalize(), birthDateSet()
A language which may be used to communicate with the patient about his or her health.
Property methods: communicationGet(), communicationGetSwizzled(), communicationIsValid(), communicationNewObject(), communicationSet()
A contact party (e.g. guardian, partner, friend) for the patient.
Property methods: contactGet(), contactGetSwizzled(), contactIsValid(), contactNewObject(), contactSet()
property contained as HS.FHIRModel.R4.SeqOfResourceList;
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Property methods: containedGet(), containedGetSwizzled(), containedIsValid(), containedNewObject(), containedSet()
property deceasedBoolean as %Boolean;
Indicates if the individual is deceased or not.
Property methods: deceasedBooleanDisplayToLogical(), deceasedBooleanGet(), deceasedBooleanIsValid(), deceasedBooleanLogicalToDisplay(), deceasedBooleanLogicalToXSD(), deceasedBooleanNormalize(), deceasedBooleanSet(), deceasedBooleanXSDToLogical()
property deceasedDateTime as %String;
Indicates if the individual is deceased or not.
Property methods: deceasedDateTimeDisplayToLogical(), deceasedDateTimeGet(), deceasedDateTimeIsValid(), deceasedDateTimeLogicalToDisplay(), deceasedDateTimeLogicalToOdbc(), deceasedDateTimeNormalize(), deceasedDateTimeSet()
property extension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Property methods: extensionGet(), extensionGetSwizzled(), extensionIsValid(), extensionNewObject(), extensionSet()
property fhirID as %String;
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
property gender as %String (VALUELIST = ",male,female,other,unknown");
Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.
Property methods: genderDisplayToLogical(), genderGet(), genderIsValid(), genderLogicalToDisplay(), genderLogicalToOdbc(), genderNormalize(), genderSet()
property generalPractitioner as HS.FHIRModel.R4.SeqOfReference;
Patient's nominated care provider.
Property methods: generalPractitionerGet(), generalPractitionerGetSwizzled(), generalPractitionerIsValid(), generalPractitionerNewObject(), generalPractitionerSet()
property identifier as HS.FHIRModel.R4.SeqOfIdentifier;
An identifier for this patient.
Property methods: identifierGet(), identifierGetSwizzled(), identifierIsValid(), identifierNewObject(), identifierSet()
property implicitRules as %String;
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Property methods: implicitRulesDisplayToLogical(), implicitRulesGet(), implicitRulesIsValid(), implicitRulesLogicalToDisplay(), implicitRulesLogicalToOdbc(), implicitRulesNormalize(), implicitRulesSet()
property language as %String;
The base language in which the resource is written.
Property methods: languageDisplayToLogical(), languageGet(), languageIsValid(), languageLogicalToDisplay(), languageLogicalToOdbc(), languageNormalize(), languageSet()
Link to another patient resource that concerns the same actual patient.
Property methods: linkGet(), linkGetSwizzled(), linkIsValid(), linkNewObject(), linkSet()
property managingOrganization as HS.FHIRModel.R4.Reference;
Organization that is the custodian of the patient record.
Property methods: managingOrganizationGet(), managingOrganizationGetSwizzled(), managingOrganizationIsValid(), managingOrganizationNewObject(), managingOrganizationSet()
property maritalStatus as HS.FHIRModel.R4.CodeableConcept;
This field contains a patient's most recent marital (civil) status.
Property methods: maritalStatusGet(), maritalStatusGetSwizzled(), maritalStatusIsValid(), maritalStatusNewObject(), maritalStatusSet()
property meta as HS.FHIRModel.R4.Meta;
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Property methods: metaGet(), metaGetSwizzled(), metaIsValid(), metaNewObject(), metaSet()
property modifierExtension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Property methods: modifierExtensionGet(), modifierExtensionGetSwizzled(), modifierExtensionIsValid(), modifierExtensionNewObject(), modifierExtensionSet()
property multipleBirthBoolean as %Boolean;
Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).
Property methods: multipleBirthBooleanDisplayToLogical(), multipleBirthBooleanGet(), multipleBirthBooleanIsValid(), multipleBirthBooleanLogicalToDisplay(), multipleBirthBooleanLogicalToXSD(), multipleBirthBooleanNormalize(), multipleBirthBooleanSet(), multipleBirthBooleanXSDToLogical()
property multipleBirthInteger as %Integer;
Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).
Property methods: multipleBirthIntegerDisplayToLogical(), multipleBirthIntegerGet(), multipleBirthIntegerIsValid(), multipleBirthIntegerLogicalToDisplay(), multipleBirthIntegerNormalize(), multipleBirthIntegerSet(), multipleBirthIntegerXSDToLogical()
property name as HS.FHIRModel.R4.SeqOfHumanName;
A name associated with the individual.
Property methods: nameGet(), nameGetSwizzled(), nameIsValid(), nameNewObject(), nameSet()
property photo as HS.FHIRModel.R4.SeqOfAttachment;
Image of the patient.
Property methods: photoGet(), photoGetSwizzled(), photoIsValid(), photoNewObject(), photoSet()
property resourceType as %String [ InitialExpression = "Patient" , Required ];
This is a Patient resource
Property methods: resourceTypeDisplayToLogical(), resourceTypeGet(), resourceTypeIsValid(), resourceTypeLogicalToDisplay(), resourceTypeLogicalToOdbc(), resourceTypeNormalize(), resourceTypeSet()
property telecom as HS.FHIRModel.R4.SeqOfContactPoint;
A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.
Property methods: telecomGet(), telecomGetSwizzled(), telecomIsValid(), telecomNewObject(), telecomSet()
property text as HS.FHIRModel.R4.Narrative;
A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Property methods: textGet(), textGetSwizzled(), textIsValid(), textNewObject(), textSet()

Methods

method IncludeAddress()
method IncludeCommunication()
method IncludeContact()
method IncludeContained()
method IncludeExtension()
method IncludeGeneralPractitioner()
method IncludeIdentifier()
method IncludeManagingOrganization()
method IncludeMaritalStatus()
method IncludeMeta()
method IncludeModifierExtension()
method IncludeName()
method IncludePhoto()
method IncludeTelecom()
method IncludeText()
method _getProperties() as %DynamicArray
Inherited description: Return an array of the defined properties of this class in the definition order that they were discovered in the the HL7FHIR JSchema document
method toDao() as %DynamicAbstractObject
Inherited description: >

The toDao() method casts the set to a DAO.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab