Skip to main content

HS.FHIR.DTL.vR4.Model.Element.Consent.provision

class HS.FHIR.DTL.vR4.Model.Element.Consent.provision extends HS.FHIR.DTL.vR4.Model.Base.BackboneElement

Constraints to the base Consent.policyRule.

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 = Consent.provision;
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 = Consent.provision;
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.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "action", XMLPROJECTION = "ELEMENT");
CodeableConcept

Actions controlled by this rule.

any FHIR4 code may be used; consent-action shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: actionBuildValueArray(), actionCollectionToDisplay(), actionCollectionToOdbc(), actionDisplayToCollection(), actionGet(), actionGetObject(), actionGetObjectId(), actionGetSwizzled(), actionIsValid(), actionOdbcToCollection(), actionSet(), actionSetObject(), actionSetObjectId()
property actor as list of HS.FHIR.DTL.vR4.Model.Element.Consent.provision.actor (XMLNAME = "actor", XMLPROJECTION = "ELEMENT");
BackboneElement

Who|what controlled by this rule (or group, by role)

Property methods: actorBuildValueArray(), actorCollectionToDisplay(), actorCollectionToOdbc(), actorDisplayToCollection(), actorGet(), actorGetObject(), actorGetObjectId(), actorGetSwizzled(), actorIsValid(), actorOdbcToCollection(), actorSet(), actorSetObject(), actorSetObjectId()
property class as list of HS.FHIR.DTL.vR4.Model.Datatype.Coding (XMLNAME = "class", XMLPROJECTION = "ELEMENT");
Coding

e.g. Resource Type, Profile, CDA, etc.

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

Property methods: classBuildValueArray(), classCollectionToDisplay(), classCollectionToOdbc(), classDisplayToCollection(), classGet(), classGetObject(), classGetObjectId(), classGetSwizzled(), classIsValid(), classOdbcToCollection(), classSet(), classSetObject(), classSetObjectId()
property code as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "code", XMLPROJECTION = "ELEMENT");
CodeableConcept

e.g. LOINC or SNOMED CT code, etc. in the content.

any FHIR4 code may be used; consent-content-code shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: codeBuildValueArray(), codeCollectionToDisplay(), codeCollectionToOdbc(), codeDisplayToCollection(), codeGet(), codeGetObject(), codeGetObjectId(), codeGetSwizzled(), codeIsValid(), codeOdbcToCollection(), codeSet(), codeSetObject(), codeSetObjectId()
property data as list of HS.FHIR.DTL.vR4.Model.Element.Consent.provision.data (XMLNAME = "data", XMLPROJECTION = "ELEMENT");
BackboneElement

Data controlled by this rule.

Property methods: dataBuildValueArray(), dataCollectionToDisplay(), dataCollectionToOdbc(), dataDisplayToCollection(), dataGet(), dataGetObject(), dataGetObjectId(), dataGetSwizzled(), dataIsValid(), dataOdbcToCollection(), dataSet(), dataSetObject(), dataSetObjectId()
property dataPeriod as HS.FHIR.DTL.vR4.Model.Datatype.Period (XMLNAME = "dataPeriod", XMLPROJECTION = "ELEMENT");
Period

Timeframe for data controlled by this rule.

Property methods: dataPeriodGet(), dataPeriodGetSwizzled(), dataPeriodIsValid(), dataPeriodNewObject(), dataPeriodSet()
property period as HS.FHIR.DTL.vR4.Model.Datatype.Period (XMLNAME = "period", XMLPROJECTION = "ELEMENT");
Period

Timeframe for this rule.

Property methods: periodGet(), periodGetSwizzled(), periodIsValid(), periodNewObject(), periodSet()
property provision as list of HS.FHIR.DTL.vR4.Model.Element.Consent.provision (XMLNAME = "provision", XMLPROJECTION = "ELEMENT");
Consent:provision

Nested Exception Rules.

Property methods: provisionBuildValueArray(), provisionCollectionToDisplay(), provisionCollectionToOdbc(), provisionDisplayToCollection(), provisionGet(), provisionGetObject(), provisionGetObjectId(), provisionGetSwizzled(), provisionIsValid(), provisionOdbcToCollection(), provisionSet(), provisionSetObject(), provisionSetObjectId()
property purpose as list of HS.FHIR.DTL.vR4.Model.Datatype.Coding (XMLNAME = "purpose", XMLPROJECTION = "ELEMENT");
Coding

Context of activities covered by this rule.

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

Property methods: purposeBuildValueArray(), purposeCollectionToDisplay(), purposeCollectionToOdbc(), purposeDisplayToCollection(), purposeGet(), purposeGetObject(), purposeGetObjectId(), purposeGetSwizzled(), purposeIsValid(), purposeOdbcToCollection(), purposeSet(), purposeSetObject(), purposeSetObjectId()
property securityLabel as list of HS.FHIR.DTL.vR4.Model.Datatype.Coding (XMLNAME = "securityLabel", XMLPROJECTION = "ELEMENT");
Coding

Security Labels that define affected resources.

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

Property methods: securityLabelBuildValueArray(), securityLabelCollectionToDisplay(), securityLabelCollectionToOdbc(), securityLabelDisplayToCollection(), securityLabelGet(), securityLabelGetObject(), securityLabelGetObjectId(), securityLabelGetSwizzled(), securityLabelIsValid(), securityLabelOdbcToCollection(), securityLabelSet(), securityLabelSetObject(), securityLabelSetObjectId()
property type as %String (MAXLEN = 1000000, XMLNAME = "type", XMLPROJECTION = "ATTRIBUTE");
code

deny | permit

consent-provision-type|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend consent-provision-type|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: typeDisplayToLogical(), typeGet(), typeIsValid(), typeLogicalToDisplay(), typeLogicalToOdbc(), typeNormalize(), typeSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab