Skip to main content

HS.FHIR.DTL.vSTU3.Model.Resource.Consent

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

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

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

Actions controlled by this consent.

any FHIR3 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.vSTU3.Model.Element.Consent.actor (XMLNAME = "actor", XMLPROJECTION = "ELEMENT");
BackboneElement

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

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

Classification of the consent statement - for indexing/retrieval.

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

Property methods: categoryBuildValueArray(), categoryCollectionToDisplay(), categoryCollectionToOdbc(), categoryDisplayToCollection(), categoryGet(), categoryGetObject(), categoryGetObjectId(), categoryGetSwizzled(), categoryIsValid(), categoryOdbcToCollection(), categorySet(), categorySetObject(), categorySetObjectId()
property consentingParty as list of HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "consentingParty", XMLPROJECTION = "ELEMENT");
Reference

Who is agreeing to the policy and exceptions.

Organization | Patient | Practitioner | RelatedPerson

Property methods: consentingPartyBuildValueArray(), consentingPartyCollectionToDisplay(), consentingPartyCollectionToOdbc(), consentingPartyDisplayToCollection(), consentingPartyGet(), consentingPartyGetObject(), consentingPartyGetObjectId(), consentingPartyGetSwizzled(), consentingPartyIsValid(), consentingPartyOdbcToCollection(), consentingPartySet(), consentingPartySetObject(), consentingPartySetObjectId()
property data as list of HS.FHIR.DTL.vSTU3.Model.Element.Consent.data (XMLNAME = "data", XMLPROJECTION = "ELEMENT");
BackboneElement

Data controlled by this consent.

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.DTL.vSTU3.Model.Datatype.Period (XMLNAME = "dataPeriod", XMLPROJECTION = "ELEMENT");
Period

Timeframe for data controlled by this consent.

Property methods: dataPeriodGet(), dataPeriodGetSwizzled(), dataPeriodIsValid(), dataPeriodNewObject(), dataPeriodSet()
property dateTime as %String (MAXLEN = 1000000, XMLNAME = "dateTime", XMLPROJECTION = "ATTRIBUTE");
dateTime

When this Consent was created or indexed.

Property methods: dateTimeDisplayToLogical(), dateTimeGet(), dateTimeIsValid(), dateTimeLogicalToDisplay(), dateTimeLogicalToOdbc(), dateTimeNormalize(), dateTimeSet()
property except as list of HS.FHIR.DTL.vSTU3.Model.Element.Consent.except (XMLNAME = "except", XMLPROJECTION = "ELEMENT");
BackboneElement

Additional rule - addition or removal of permissions.

Property methods: exceptBuildValueArray(), exceptCollectionToDisplay(), exceptCollectionToOdbc(), exceptDisplayToCollection(), exceptGet(), exceptGetObject(), exceptGetObjectId(), exceptGetSwizzled(), exceptIsValid(), exceptOdbcToCollection(), exceptSet(), exceptSetObject(), exceptSetObjectId()
property identifier as HS.FHIR.DTL.vSTU3.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
Identifier

Identifier for this record (external references)

Property methods: identifierGet(), identifierGetSwizzled(), identifierIsValid(), identifierNewObject(), identifierSet()
property organization as list of HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "organization", XMLPROJECTION = "ELEMENT");
Reference

Custodian of the consent.

Organization

Property methods: organizationBuildValueArray(), organizationCollectionToDisplay(), organizationCollectionToOdbc(), organizationDisplayToCollection(), organizationGet(), organizationGetObject(), organizationGetObjectId(), organizationGetSwizzled(), organizationIsValid(), organizationOdbcToCollection(), organizationSet(), organizationSetObject(), organizationSetObjectId()
property patient as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "patient", XMLPROJECTION = "ELEMENT") [ Required ];
Reference

Who the consent applies to.

Patient

Property methods: patientGet(), patientGetSwizzled(), patientIsValid(), patientNewObject(), patientSet()
property period as HS.FHIR.DTL.vSTU3.Model.Datatype.Period (XMLNAME = "period", XMLPROJECTION = "ELEMENT");
Period

Period that this consent applies.

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

Policies covered by this consent.

Property methods: policyBuildValueArray(), policyCollectionToDisplay(), policyCollectionToOdbc(), policyDisplayToCollection(), policyGet(), policyGetObject(), policyGetObjectId(), policyGetSwizzled(), policyIsValid(), policyOdbcToCollection(), policyRuleDisplayToLogical(), policyRuleGet(), policyRuleIsValid(), policyRuleLogicalToDisplay(), policyRuleLogicalToOdbc(), policyRuleNormalize(), policyRuleSet(), policySet(), policySetObject(), policySetObjectId()
property policyRule as %String (MAXLEN = 1000000, XMLNAME = "policyRule", XMLPROJECTION = "ATTRIBUTE");
uri

Policy that this consents to.

Property methods: policyRuleDisplayToLogical(), policyRuleGet(), policyRuleIsValid(), policyRuleLogicalToDisplay(), policyRuleLogicalToOdbc(), policyRuleNormalize(), policyRuleSet()
property purpose as list of HS.FHIR.DTL.vSTU3.Model.Datatype.Coding (XMLNAME = "purpose", XMLPROJECTION = "ELEMENT");
Coding

Context of activities for which the agreement is made.

v3-PurposeOfUse is the REQUIRED FHIR3 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.vSTU3.Model.Datatype.Coding (XMLNAME = "securityLabel", XMLPROJECTION = "ELEMENT");
Coding

Security Labels that define affected resources.

security-labels is the REQUIRED FHIR3 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 sourceAttachment as HS.FHIR.DTL.vSTU3.Model.Datatype.Attachment (XMLNAME = "sourceAttachment", XMLPROJECTION = "ELEMENT");
Attachment

Source from which this consent is taken.

Property methods: sourceAttachmentGet(), sourceAttachmentGetSwizzled(), sourceAttachmentIsValid(), sourceAttachmentNewObject(), sourceAttachmentSet()
property sourceIdentifier as HS.FHIR.DTL.vSTU3.Model.Datatype.Identifier (XMLNAME = "sourceIdentifier", XMLPROJECTION = "ELEMENT");
Identifier

Source from which this consent is taken.

Property methods: sourceIdentifierGet(), sourceIdentifierGetSwizzled(), sourceIdentifierIsValid(), sourceIdentifierNewObject(), sourceIdentifierSet()
property sourceReference as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "sourceReference", XMLPROJECTION = "ELEMENT");
Reference

Source from which this consent is taken.

Consent | DocumentReference | Contract | QuestionnaireResponse

Property methods: sourceReferenceGet(), sourceReferenceGetSwizzled(), sourceReferenceIsValid(), sourceReferenceNewObject(), sourceReferenceSet()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

draft | proposed | active | rejected | inactive | entered-in-error

consent-state-codes is the REQUIRED FHIR3 ValueSet for codes; you may NOT extend consent-state-codes and you may NOT use codes from other ValueSets.

Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab