Consent
A record of a healthcare consumer’s 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.
- Backends
- PostgreSQLElasticsearch
- Interactions
- CreateReadUpdatePatchDelete
- Search
- 15 of 15 parameters tested
Structure
| Element | Card. | Type | Description |
|---|---|---|---|
identifierΣ | 0..* | Identifier | Identifier for this record (external references) |
statusRequired?!Σ | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-errorBinding (required): consent-state-codes |
scopeRequired?!Σ | 1..1 | CodeableConcept | Which of the four areas this resource covers (extensible)Binding (extensible): consent-scope |
categoryRequiredΣ | 1..* | CodeableConcept | Classification of the consent statement - for indexing/retrievalBinding (extensible): consent-category |
patientΣ | 0..1 | Reference(Patient) | Who the consent applies to |
dateTimeΣ | 0..1 | dateTime | When this Consent was created or indexed |
performerΣ | 0..* | Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Who is agreeing to the policy and rules |
organizationΣ | 0..* | Reference(Organization) | Custodian of the consent |
source[x]Σ | 0..1 | Attachment | Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) | Source from which this consent is taken |
policy | 0..* | BackboneElement | Policies covered by this consent |
authority | 0..1 | uri | Enforcement source for policy |
uri | 0..1 | uri | Specific policy covered by this consent |
policyRuleΣ | 0..1 | CodeableConcept | Regulation that this consents toBinding (extensible): consent-policy |
verificationΣ | 0..* | BackboneElement | Consent Verified by patient or family |
verifiedRequiredΣ | 1..1 | boolean | Has been verified |
verifiedWith | 0..1 | Reference(Patient | RelatedPerson) | Person who verified |
verificationDate | 0..1 | dateTime | When consent verified |
provisionΣ | 0..1 | BackboneElement | Constraints to the base Consent.policyRule |
typeΣ | 0..1 | code | deny | permitBinding (required): consent-provision-type |
periodΣ | 0..1 | Period | Timeframe for this rule |
actor | 0..* | BackboneElement | Who|what controlled by this rule (or group, by role) |
roleRequired | 1..1 | CodeableConcept | How the actor is involvedBinding (extensible): security-role-type |
referenceRequired | 1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Resource for the actor (or group, by role) |
actionΣ | 0..* | CodeableConcept | Actions controlled by this ruleBinding (example): consent-action |
securityLabelΣ | 0..* | Coding | Security Labels that define affected resourcesBinding (extensible): security-labels |
purposeΣ | 0..* | Coding | Context of activities covered by this ruleBinding (extensible): v3-PurposeOfUse |
classΣ | 0..* | Coding | e.g. Resource Type, Profile, CDA, etc.Binding (extensible): consent-content-class |
codeΣ | 0..* | CodeableConcept | e.g. LOINC or SNOMED CT code, etc. in the contentBinding (example): consent-content-code |
dataPeriodΣ | 0..1 | Period | Timeframe for data controlled by this rule |
dataΣ | 0..* | BackboneElement | Data controlled by this rule |
meaningRequiredΣ | 1..1 | code | instance | related | dependents | authoredbyBinding (required): consent-data-meaning |
referenceRequiredΣ | 1..1 | Reference(Resource) | The actual data reference |
provision | 0..* | Same as Consent.provision | Nested Exception Rules |
Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey
Search parameters
Query with GET [base]/Consent?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.
| Parameter | Type | Description | PG | ES |
|---|---|---|---|---|
action | token | Actions controlled by this rule Consent.provision.action | ||
actor | reference | Resource for the actor (or group, by role) Consent.provision.actor.reference | ||
category | token | Classification of the consent statement - for indexing/retrieval Consent.category | ||
consentor | reference | Who is agreeing to the policy and rules Consent.performer | ||
data | reference | The actual data reference Consent.provision.data.reference | ||
date | date | When this Consent was created or indexed Consent.dateTime | ||
identifier | token | Identifier for this record (external references) Consent.identifier | ||
organization | reference | Custodian of the consent Consent.organization | ||
patient | reference | Who the consent applies to Consent.patient | ||
period | date | Timeframe for this rule Consent.provision.period | ||
purpose | token | Context of activities covered by this rule Consent.provision.purpose | ||
scope | token | Which of the four areas this resource covers (extensible) Consent.scope | ||
security-label | token | Security Labels that define affected resources Consent.provision.securityLabel | ||
source-reference | reference | Search by reference to a Consent, DocumentReference, Contract or QuestionnaireResponse Consent.source.ofType(Reference) | ||
status | token | draft | proposed | active | rejected | inactive | entered-in-error Consent.status |
PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet. The author of the resource Logical id of this artifact When the resource version last changed Profiles this resource claims to conform to Security Labels applied to this resource Identifies where the resource comes from Tags applied to this resource Derived from the R4B DefinitionCommon parameters on every resource (8)
_haste-health-authorreference _idtoken _lastUpdateddate _profileuri _securitytoken _sourceuri _tagtoken _typetoken