description: 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.
package_name: hl7.fhir.r4b.examples
derivation: specialization
name: Consent
type: Consent
elements:
  patient:
    isModifier: false
    short: Who the consent applies to
    refers: ['http://hl7.org/fhir/StructureDefinition/Patient']
    type: Reference
    mustSupport: false
    isSummary: true
    index: 4
  category:
    min: 1
    isModifier: false
    short: Classification of the consent statement - for indexing/retrieval
    index: 3
    type: CodeableConcept
    mustSupport: false
    array: true
    binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/consent-category'}
    isSummary: true
  provision:
    isModifier: false
    short: Constraints to the base Consent.policyRule
    type: BackboneElement
    mustSupport: false
    isSummary: true
    index: 20
    elements:
      provision:
        elementReference: ['http://hl7.org/fhir/StructureDefinition/Consent', elements, provision]
        isModifier: false
        short: Nested Exception Rules
        mustSupport: false
        array: true
        isSummary: false
        index: 35
      purpose:
        isModifier: false
        short: Context of activities covered by this rule
        type: Coding
        mustSupport: false
        array: true
        binding: {strength: extensible, valueSet: 'http://terminology.hl7.org/ValueSet/v3-PurposeOfUse'}
        isSummary: true
        index: 28
      dataPeriod: {isModifier: false, short: Timeframe for data controlled by this rule, type: Period, mustSupport: false, isSummary: true, index: 31}
      type:
        isModifier: false
        short: deny | permit
        type: code
        mustSupport: false
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/consent-provision-type|4.3.0'}
        isSummary: true
        index: 21
      class:
        isModifier: false
        short: e.g. Resource Type, Profile, CDA, etc.
        type: Coding
        mustSupport: false
        array: true
        binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/consent-content-class'}
        isSummary: true
        index: 29
      code:
        isModifier: false
        short: e.g. LOINC or SNOMED CT code, etc. in the content
        type: CodeableConcept
        mustSupport: false
        array: true
        binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/consent-content-code'}
        isSummary: true
        index: 30
      action:
        isModifier: false
        short: Actions controlled by this rule
        index: 26
        type: CodeableConcept
        mustSupport: false
        array: true
        meaningWhenMissing: all actions
        binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/consent-action'}
        isSummary: true
      period: {isModifier: false, short: Timeframe for this rule, type: Period, mustSupport: false, isSummary: true, index: 22}
      securityLabel:
        isModifier: false
        short: Security Labels that define affected resources
        type: Coding
        mustSupport: false
        array: true
        binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/security-labels'}
        isSummary: true
        index: 27
      actor:
        isModifier: false
        short: Who|what controlled by this rule (or group, by role)
        index: 23
        type: BackboneElement
        mustSupport: false
        array: true
        elements:
          role:
            isModifier: false
            short: How the actor is involved
            type: CodeableConcept
            mustSupport: false
            binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/security-role-type'}
            isSummary: false
            index: 24
          reference:
            isModifier: false
            short: Resource for the actor (or group, by role)
            refers: ['http://hl7.org/fhir/StructureDefinition/CareTeam', 'http://hl7.org/fhir/StructureDefinition/Device', 'http://hl7.org/fhir/StructureDefinition/Group', 'http://hl7.org/fhir/StructureDefinition/Organization', 'http://hl7.org/fhir/StructureDefinition/Patient', 'http://hl7.org/fhir/StructureDefinition/Practitioner', 'http://hl7.org/fhir/StructureDefinition/PractitionerRole', 'http://hl7.org/fhir/StructureDefinition/RelatedPerson']
            type: Reference
            mustSupport: false
            isSummary: false
            index: 25
        meaningWhenMissing: There is no specific actor associated with the exception
        required: [role, reference]
        isSummary: false
      data:
        isModifier: false
        short: Data controlled by this rule
        index: 32
        type: BackboneElement
        mustSupport: false
        array: true
        elements:
          meaning:
            isModifier: false
            short: instance | related | dependents | authoredby
            type: code
            mustSupport: false
            binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/consent-data-meaning|4.3.0'}
            isSummary: true
            index: 33
          reference:
            isModifier: false
            short: The actual data reference
            refers: ['http://hl7.org/fhir/StructureDefinition/Resource']
            type: Reference
            mustSupport: false
            isSummary: true
            index: 34
        meaningWhenMissing: all data
        required: [meaning, reference]
        isSummary: true
  sourceAttachment: {isModifier: false, short: Source from which this consent is taken, type: Attachment, mustSupport: false, choiceOf: source, isSummary: true, index: 10}
  organization:
    isModifier: false
    short: Custodian of the consent
    refers: ['http://hl7.org/fhir/StructureDefinition/Organization']
    type: Reference
    mustSupport: false
    array: true
    isSummary: true
    index: 7
  verification:
    isModifier: false
    short: Consent Verified by patient or family
    index: 16
    type: BackboneElement
    mustSupport: false
    array: true
    elements:
      verified: {isModifier: false, short: Has been verified, type: boolean, mustSupport: false, isSummary: true, index: 17}
      verifiedWith:
        isModifier: false
        short: Person who verified
        refers: ['http://hl7.org/fhir/StructureDefinition/Patient', 'http://hl7.org/fhir/StructureDefinition/RelatedPerson']
        type: Reference
        mustSupport: false
        isSummary: false
        index: 18
      verificationDate: {isModifier: false, short: When consent verified, type: dateTime, mustSupport: false, isSummary: false, index: 19}
    required: [verified]
    isSummary: true
  source:
    isModifier: false
    short: Source from which this consent is taken
    mustSupport: false
    choices: [sourceAttachment, sourceReference]
    isSummary: true
    index: 9
  scope:
    isModifier: true
    short: Which of the four areas this resource covers (extensible)
    index: 2
    type: CodeableConcept
    mustSupport: false
    binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/consent-scope'}
    isModifierReason: Allows changes to codes based on scope selection
    isSummary: true
  policy:
    isModifier: false
    short: Policies covered by this consent
    type: BackboneElement
    mustSupport: false
    array: true
    isSummary: false
    index: 12
    elements:
      authority: {isModifier: false, short: Enforcement source for policy, type: uri, mustSupport: false, isSummary: false, index: 13}
      uri: {isModifier: false, short: Specific policy covered by this consent, type: uri, mustSupport: false, isSummary: false, index: 14}
  sourceReference:
    isModifier: false
    short: Source from which this consent is taken
    refers: ['http://hl7.org/fhir/StructureDefinition/Consent', 'http://hl7.org/fhir/StructureDefinition/Contract', 'http://hl7.org/fhir/StructureDefinition/DocumentReference', 'http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse']
    type: Reference
    mustSupport: false
    choiceOf: source
    isSummary: true
    index: 11
  dateTime: {isModifier: false, short: When this Consent was created or indexed, type: dateTime, mustSupport: false, isSummary: true, index: 5}
  status:
    isModifier: true
    short: draft | proposed | active | rejected | inactive | entered-in-error
    index: 1
    type: code
    mustSupport: false
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/consent-state-codes|4.3.0'}
    isModifierReason: This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
    isSummary: true
  policyRule:
    isModifier: false
    short: Regulation that this consents to
    type: CodeableConcept
    mustSupport: false
    binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/consent-policy'}
    isSummary: true
    index: 15
  identifier: {isModifier: false, short: Identifier for this record (external references), type: Identifier, mustSupport: false, array: true, isSummary: true, index: 0}
  performer:
    isModifier: false
    short: Who is agreeing to the policy and rules
    refers: ['http://hl7.org/fhir/StructureDefinition/Organization', 'http://hl7.org/fhir/StructureDefinition/Patient', 'http://hl7.org/fhir/StructureDefinition/Practitioner', 'http://hl7.org/fhir/StructureDefinition/PractitionerRole', 'http://hl7.org/fhir/StructureDefinition/RelatedPerson']
    type: Reference
    mustSupport: false
    array: true
    isSummary: true
    index: 6
package_version: 4.3.0
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/Consent
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: 4.3.0
required: [status, scope, category]