Skip to main content


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

A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time.

Property Inventory


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.
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.


property category as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "category", XMLPROJECTION = "ELEMENT") [ Required ];

Classification of the consent statement - for indexing/retrieval.

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

Property methods: categoryBuildValueArray(), categoryCollectionToDisplay(), categoryCollectionToOdbc(), categoryDisplayToCollection(), categoryGet(), categoryGetObject(), categoryGetObjectId(), categoryGetSwizzled(), categoryIsValid(), categoryOdbcToCollection(), categorySet(), categorySetObject(), categorySetObjectId()
property dateTime as %String (MAXLEN = 1000000, XMLNAME = "dateTime", XMLPROJECTION = "ATTRIBUTE");

When this Consent was created or indexed.

Property methods: dateTimeDisplayToLogical(), dateTimeGet(), dateTimeIsValid(), dateTimeLogicalToDisplay(), dateTimeLogicalToOdbc(), dateTimeNormalize(), dateTimeSet()
property identifier as list of HS.FHIR.DTL.vR4.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");

Identifier for this record (external references)

Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property organization as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "organization", XMLPROJECTION = "ELEMENT");

Custodian of the consent.


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

Who the consent applies to.


Property methods: patientGet(), patientGetSwizzled(), patientIsValid(), patientNewObject(), patientSet()
property performer as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "performer", XMLPROJECTION = "ELEMENT");

Who is agreeing to the policy and rules.

Organization | Patient | Practitioner | RelatedPerson | PractitionerRole

Property methods: performerBuildValueArray(), performerCollectionToDisplay(), performerCollectionToOdbc(), performerDisplayToCollection(), performerGet(), performerGetObject(), performerGetObjectId(), performerGetSwizzled(), performerIsValid(), performerOdbcToCollection(), performerSet(), performerSetObject(), performerSetObjectId()
property policy as list of HS.FHIR.DTL.vR4.Model.Element.Consent.policy (XMLNAME = "policy", XMLPROJECTION = "ELEMENT");

Policies covered by this consent.

Property methods: policyBuildValueArray(), policyCollectionToDisplay(), policyCollectionToOdbc(), policyDisplayToCollection(), policyGet(), policyGetObject(), policyGetObjectId(), policyGetSwizzled(), policyIsValid(), policyOdbcToCollection(), policySet(), policySetObject(), policySetObjectId()
property policyRule as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "policyRule", XMLPROJECTION = "ELEMENT");

Regulation that this consents to.

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

Property methods: policyRuleGet(), policyRuleGetSwizzled(), policyRuleIsValid(), policyRuleNewObject(), policyRuleSet()
property provision as HS.FHIR.DTL.vR4.Model.Element.Consent.provision (XMLNAME = "provision", XMLPROJECTION = "ELEMENT");

Constraints to the base Consent.policyRule.

Property methods: provisionGet(), provisionGetSwizzled(), provisionIsValid(), provisionNewObject(), provisionSet()
property scope as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "scope", XMLPROJECTION = "ELEMENT") [ Required ];

Which of the four areas this resource covers (extensible)

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

Property methods: scopeGet(), scopeGetSwizzled(), scopeIsValid(), scopeNewObject(), scopeSet()
property sourceAttachment as HS.FHIR.DTL.vR4.Model.Datatype.Attachment (XMLNAME = "sourceAttachment", XMLPROJECTION = "ELEMENT");

Source from which this consent is taken.

Property methods: sourceAttachmentGet(), sourceAttachmentGetSwizzled(), sourceAttachmentIsValid(), sourceAttachmentNewObject(), sourceAttachmentSet()
property sourceReference as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "sourceReference", XMLPROJECTION = "ELEMENT");

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 ];

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

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

Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property verification as list of HS.FHIR.DTL.vR4.Model.Element.Consent.verification (XMLNAME = "verification", XMLPROJECTION = "ELEMENT");

Consent Verified by patient or family.

Property methods: verificationBuildValueArray(), verificationCollectionToDisplay(), verificationCollectionToOdbc(), verificationDisplayToCollection(), verificationGet(), verificationGetObject(), verificationGetObjectId(), verificationGetSwizzled(), verificationIsValid(), verificationOdbcToCollection(), verificationSet(), verificationSetObject(), verificationSetObjectId()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab