Skip to main content

HS.FHIR.vSTU3.Model.Resource.Consent

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

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
A record of a healthcare consumer’s policy choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.
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 = Consent;
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 action as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "action", XMLPROJECTION = "ELEMENT");
Actions controlled by this consent.
Property methods: actionBuildValueArray(), actionCollectionToDisplay(), actionCollectionToOdbc(), actionDisplayToCollection(), actionGet(), actionGetObject(), actionGetObjectId(), actionGetSwizzled(), actionIsValid(), actionOdbcToCollection(), actionSet(), actionSetObject(), actionSetObjectId()
property actor as list of HS.FHIR.vSTU3.Model.Resource.Consent.Actor (XMLNAME = "actor", XMLPROJECTION = "ELEMENT");
Who or what is controlled by this consent. Use group to identify a set of actors by some property they share (e.g. 'admitting officers').
Property methods: actorBuildValueArray(), actorCollectionToDisplay(), actorCollectionToOdbc(), actorDisplayToCollection(), actorGet(), actorGetObject(), actorGetObjectId(), actorGetSwizzled(), actorIsValid(), actorOdbcToCollection(), actorSet(), actorSetObject(), actorSetObjectId()
property category as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "category", XMLPROJECTION = "ELEMENT");
A classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements.
Property methods: categoryBuildValueArray(), categoryCollectionToDisplay(), categoryCollectionToOdbc(), categoryDisplayToCollection(), categoryGet(), categoryGetObject(), categoryGetObjectId(), categoryGetSwizzled(), categoryIsValid(), categoryOdbcToCollection(), categorySet(), categorySetObject(), categorySetObjectId()
property consentingParty as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "consentingParty", XMLPROJECTION = "ELEMENT");
Either the Grantor, which is the entity responsible for granting the rights listed in a Consent Directive or the Grantee, which is the entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations and enforcement of prohibitions.
Property methods: consentingPartyBuildValueArray(), consentingPartyCollectionToDisplay(), consentingPartyCollectionToOdbc(), consentingPartyDisplayToCollection(), consentingPartyGet(), consentingPartyGetObject(), consentingPartyGetObjectId(), consentingPartyGetSwizzled(), consentingPartyIsValid(), consentingPartyOdbcToCollection(), consentingPartySet(), consentingPartySetObject(), consentingPartySetObjectId()
property data as list of HS.FHIR.vSTU3.Model.Resource.Consent.Data (XMLNAME = "data", XMLPROJECTION = "ELEMENT");
The resources controlled by this consent, if specific resources are referenced.
Property methods: dataBuildValueArray(), dataCollectionToDisplay(), dataCollectionToOdbc(), dataDisplayToCollection(), dataGet(), dataGetObject(), dataGetObjectId(), dataGetSwizzled(), dataIsValid(), dataOdbcToCollection(), dataPeriodGet(), dataPeriodGetSwizzled(), dataPeriodIsValid(), dataPeriodNewObject(), dataPeriodSet(), dataSet(), dataSetObject(), dataSetObjectId()
property dataPeriod as HS.FHIR.vSTU3.Model.Base.Period (XMLNAME = "dataPeriod", XMLPROJECTION = "ELEMENT");
Clinical or Operational Relevant period of time that bounds the data controlled by this consent.
Property methods: dataPeriodGet(), dataPeriodGetSwizzled(), dataPeriodIsValid(), dataPeriodNewObject(), dataPeriodSet()
property dateTime as HS.FHIR.vSTU3.Model.Datatype.DateTime (XMLNAME = "dateTime", XMLPROJECTION = "ELEMENT");
When this Consent was issued / created / indexed.
Property methods: dateTimeGet(), dateTimeGetSwizzled(), dateTimeIsValid(), dateTimeNewObject(), dateTimeSet()
property except as list of HS.FHIR.vSTU3.Model.Resource.Consent.Except (XMLNAME = "except", XMLPROJECTION = "ELEMENT");
An exception to the base policy of this consent. An exception can be an addition or removal of access permissions.
Property methods: exceptBuildValueArray(), exceptCollectionToDisplay(), exceptCollectionToOdbc(), exceptDisplayToCollection(), exceptGet(), exceptGetObject(), exceptGetObjectId(), exceptGetSwizzled(), exceptIsValid(), exceptOdbcToCollection(), exceptSet(), exceptSetObject(), exceptSetObjectId()
property identifier as HS.FHIR.vSTU3.Model.Base.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
Unique identifier for this copy of the Consent Statement.
Property methods: identifierGet(), identifierGetSwizzled(), identifierIsValid(), identifierNewObject(), identifierSet()
property organization as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "organization", XMLPROJECTION = "ELEMENT");
The organization that manages the consent, and the framework within which it is executed.
Property methods: organizationBuildValueArray(), organizationCollectionToDisplay(), organizationCollectionToOdbc(), organizationDisplayToCollection(), organizationGet(), organizationGetObject(), organizationGetObjectId(), organizationGetSwizzled(), organizationIsValid(), organizationOdbcToCollection(), organizationSet(), organizationSetObject(), organizationSetObjectId()
property patient as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "patient", XMLPROJECTION = "ELEMENT") [ Required ];
The patient/healthcare consumer to whom this consent applies.
Property methods: patientGet(), patientGetSwizzled(), patientIsValid(), patientNewObject(), patientSet()
property period as HS.FHIR.vSTU3.Model.Base.Period (XMLNAME = "period", XMLPROJECTION = "ELEMENT");
Relevant time or time-period when this Consent is applicable.
Property methods: periodGet(), periodGetSwizzled(), periodIsValid(), periodNewObject(), periodSet()
property policy as list of HS.FHIR.vSTU3.Model.Resource.Consent.Policy (XMLNAME = "policy", XMLPROJECTION = "ELEMENT");
The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law.
Property methods: policyBuildValueArray(), policyCollectionToDisplay(), policyCollectionToOdbc(), policyDisplayToCollection(), policyGet(), policyGetObject(), policyGetObjectId(), policyGetSwizzled(), policyIsValid(), policyOdbcToCollection(), policyRuleGet(), policyRuleGetSwizzled(), policyRuleIsValid(), policyRuleNewObject(), policyRuleSet(), policySet(), policySetObject(), policySetObjectId()
property policyRule as HS.FHIR.vSTU3.Model.Datatype.Uri (XMLNAME = "policyRule", XMLPROJECTION = "ELEMENT");
A referece to the specific computable policy.
Property methods: policyRuleGet(), policyRuleGetSwizzled(), policyRuleIsValid(), policyRuleNewObject(), policyRuleSet()
property purpose as list of HS.FHIR.vSTU3.Model.Base.Coding (XMLNAME = "purpose", XMLPROJECTION = "ELEMENT");
The context of the activities a user is taking - why the user is accessing the data - that are controlled by this consent.
Property methods: purposeBuildValueArray(), purposeCollectionToDisplay(), purposeCollectionToOdbc(), purposeDisplayToCollection(), purposeGet(), purposeGetObject(), purposeGetObjectId(), purposeGetSwizzled(), purposeIsValid(), purposeOdbcToCollection(), purposeSet(), purposeSetObject(), purposeSetObjectId()
property securityLabel as list of HS.FHIR.vSTU3.Model.Base.Coding (XMLNAME = "securityLabel", XMLPROJECTION = "ELEMENT");
A set of security labels that define which resources are controlled by this consent. If more than one label is specified, all resources must have all the specified labels.
Property methods: securityLabelBuildValueArray(), securityLabelCollectionToDisplay(), securityLabelCollectionToOdbc(), securityLabelDisplayToCollection(), securityLabelGet(), securityLabelGetObject(), securityLabelGetObjectId(), securityLabelGetSwizzled(), securityLabelIsValid(), securityLabelOdbcToCollection(), securityLabelSet(), securityLabelSetObject(), securityLabelSetObjectId()
property sourceAttachment as HS.FHIR.vSTU3.Model.Base.Attachment (XMLNAME = "sourceAttachment", XMLPROJECTION = "ELEMENT");
Property methods: sourceAttachmentGet(), sourceAttachmentGetSwizzled(), sourceAttachmentIsValid(), sourceAttachmentNewObject(), sourceAttachmentSet()
property sourceIdentifier as HS.FHIR.vSTU3.Model.Base.Identifier (XMLNAME = "sourceIdentifier", XMLPROJECTION = "ELEMENT");
Property methods: sourceIdentifierGet(), sourceIdentifierGetSwizzled(), sourceIdentifierIsValid(), sourceIdentifierNewObject(), sourceIdentifierSet()
property sourceReference as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "sourceReference", XMLPROJECTION = "ELEMENT");
Property methods: sourceReferenceGet(), sourceReferenceGetSwizzled(), sourceReferenceIsValid(), sourceReferenceNewObject(), sourceReferenceSet()
property status as HS.FHIR.vSTU3.Model.Base.ConsentState (XMLNAME = "status", XMLPROJECTION = "ELEMENT") [ Required ];
Indicates the current state of this consent.
Property methods: statusGet(), statusGetSwizzled(), statusIsValid(), statusNewObject(), statusSet()

Methods

deprecated method SetAction(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.
Insert method for the "action" property.
deprecated method SetCategory(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.
Insert method for the "category" property.
deprecated method SetConsentingParty(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 "consentingParty" property.
deprecated method SetDataPeriod(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 "dataPeriod" property.
deprecated method SetDateTime(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 "dateTime" 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.
Set method for the "identifier" property.
deprecated method SetOrganization(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 "organization" 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 SetPolicyRule(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 "policyRule" property.
deprecated method SetPurpose(pCode As %String = "", pDisplay As %String = "", pSystem 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.
Insert method for the "purpose" property.
deprecated method SetSecurityLabel(pCode As %String = "", pDisplay As %String = "", pSystem 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.
Insert method for the "securityLabel" property.
deprecated method SetSourceAttachment(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.
Set method for the "sourceAttachment" property.
deprecated method SetSourceIdentifier(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.
Set method for the "sourceIdentifier" property.
deprecated method SetSourceReference(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 "sourceReference" property.
deprecated method SetStatus(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 "status" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab