Skip to main content

HS.FHIR.vSTU3.Model.Resource.Consent.Except

deprecated class HS.FHIR.vSTU3.Model.Resource.Consent.Except extends HS.FHIR.vSTU3.Model.Base.BackboneElement

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.

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 JSONTYPEFIELD;
Inherited description: Type property name for JSON export.
parameter XMLNAME = Consent.Except;
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 = Consent.Except;
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 action as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "action", XMLPROJECTION = "ELEMENT");
Actions controlled by this Exception.
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.Actor1 (XMLNAME = "actor", XMLPROJECTION = "ELEMENT");
Who or what is controlled by this Exception. 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 class as list of HS.FHIR.vSTU3.Model.Base.Coding (XMLNAME = "class", XMLPROJECTION = "ELEMENT");
The class of information covered by this exception. The type can be a FHIR resource type, a profile on a type, or a CDA document, or some other type that indicates what sort of information the consent relates to.
Property methods: classBuildValueArray(), classCollectionToDisplay(), classCollectionToOdbc(), classDisplayToCollection(), classGet(), classGetObject(), classGetObjectId(), classGetSwizzled(), classIsValid(), classOdbcToCollection(), classSet(), classSetObject(), classSetObjectId()
property code as list of HS.FHIR.vSTU3.Model.Base.Coding (XMLNAME = "code", XMLPROJECTION = "ELEMENT");
If this code is found in an instance, then the exception applies.
Property methods: codeBuildValueArray(), codeCollectionToDisplay(), codeCollectionToOdbc(), codeDisplayToCollection(), codeGet(), codeGetObject(), codeGetObjectId(), codeGetSwizzled(), codeIsValid(), codeOdbcToCollection(), codeSet(), codeSetObject(), codeSetObjectId()
property data as list of HS.FHIR.vSTU3.Model.Resource.Consent.Data1 (XMLNAME = "data", XMLPROJECTION = "ELEMENT");
The resources controlled by this exception, 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 exception.
Property methods: dataPeriodGet(), dataPeriodGetSwizzled(), dataPeriodIsValid(), dataPeriodNewObject(), dataPeriodSet()
property period as HS.FHIR.vSTU3.Model.Base.Period (XMLNAME = "period", XMLPROJECTION = "ELEMENT");
The timeframe in this exception is valid.
Property methods: periodGet(), periodGetSwizzled(), periodIsValid(), periodNewObject(), periodSet()
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 exception.
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 exception. 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 type as HS.FHIR.vSTU3.Model.Base.ConsentExceptType (XMLNAME = "type", XMLPROJECTION = "ELEMENT") [ Required ];
Action to take - permit or deny - when the exception conditions are met.
Property methods: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()

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 SetClass(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 "class" property.
deprecated method SetCode(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 "code" 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 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 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 SetType(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 "type" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab