PackagesCanonicalsLogsProblems
    Packages
    hl7.fhir.r5.core@5.0.0-ballot
    http://hl7.org/fhir/StructureDefinition/Consent
description: A record of a healthcare consumer’s  choices  or choices made on their behalf by a third party, 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.r5.core
derivation: specialization
name: Consent
type: Consent
elements:
  category:
    isModifier: false
    short: Classification of the consent statement - for indexing/retrieval
    type: CodeableConcept
    mustSupport: false
    array: true
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/consent-category'}
    isSummary: true
    index: 2
  provision:
    isModifier: false
    short: Constraints to the base Consent.policyRule/Consent.policy
    type: BackboneElement
    mustSupport: false
    isSummary: true
    index: 22
    elements:
      provision:
        elementReference: ['http://hl7.org/fhir/StructureDefinition/Consent', elements, provision]
        isModifier: false
        short: Nested Exception Rules
        mustSupport: false
        array: true
        isSummary: false
        index: 38
      expression: {isModifier: false, short: A computable expression of the consent, type: Expression, mustSupport: false, isSummary: false, index: 37}
      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: 30
      dataPeriod: {isModifier: false, short: Timeframe for data controlled by this rule, type: Period, mustSupport: false, isSummary: true, index: 33}
      type:
        isModifier: true
        short: deny | permit
        type: code
        mustSupport: false
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/consent-provision-type|5.0.0-ballot'}
        isModifierReason: Sets context for the other values in .provision
        isSummary: true
        index: 23
      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: 31
      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: 32
      action:
        isModifier: false
        short: Actions controlled by this rule
        index: 28
        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: 24}
      securityLabel:
        isModifier: false
        short: Security Labels that define affected resources
        type: Coding
        mustSupport: false
        array: true
        binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/security-label-examples'}
        isSummary: true
        index: 29
      actor:
        isModifier: false
        short: Who|what controlled by this rule (or group, by role)
        index: 25
        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/participation-role-type'}
            isSummary: false
            index: 26
          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: 27
        meaningWhenMissing: There is no specific actor associated with the exception
        isSummary: false
      data:
        isModifier: false
        short: Data controlled by this rule
        index: 34
        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|5.0.0-ballot'}
            isSummary: true
            index: 35
          reference:
            isModifier: false
            short: The actual data reference
            refers: ['http://hl7.org/fhir/StructureDefinition/Resource']
            type: Reference
            mustSupport: false
            isSummary: true
            index: 36
        meaningWhenMissing: all data
        required: [meaning, reference]
        isSummary: true
  controller:
    isModifier: false
    short: Consent Enforcer
    refers: ['http://hl7.org/fhir/StructureDefinition/HealthcareService', 'http://hl7.org/fhir/StructureDefinition/Organization', 'http://hl7.org/fhir/StructureDefinition/Patient', 'http://hl7.org/fhir/StructureDefinition/Practitioner']
    type: Reference
    mustSupport: false
    array: true
    isSummary: false
    index: 8
  policyBasis:
    isModifier: false
    short: Computable version of the backing policy
    type: BackboneElement
    mustSupport: false
    isSummary: false
    index: 12
    elements:
      reference:
        isModifier: false
        short: Reference backing policy resource
        refers: ['http://hl7.org/fhir/StructureDefinition/Resource']
        type: Reference
        mustSupport: false
        isSummary: false
        index: 13
      url: {isModifier: false, short: URL to a computable backing policy, type: url, mustSupport: false, isSummary: false, index: 14}
  regulatoryBasis:
    isModifier: false
    short: Regulations establishing base Consent
    type: CodeableConcept
    mustSupport: false
    array: true
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/consent-policy'}
    isSummary: false
    index: 11
  sourceAttachment: {isModifier: false, short: Source from which this consent is taken, type: Attachment, mustSupport: false, array: true, isSummary: false, index: 9}
  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}
      verificationType:
        isModifier: false
        short: Business case of verification
        type: CodeableConcept
        mustSupport: false
        binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/consent-verification'}
        isSummary: false
        index: 18
      verifiedBy:
        isModifier: false
        short: Person conducting verification
        refers: ['http://hl7.org/fhir/StructureDefinition/Organization', 'http://hl7.org/fhir/StructureDefinition/Practitioner', 'http://hl7.org/fhir/StructureDefinition/PractitionerRole']
        type: Reference
        mustSupport: false
        isSummary: false
        index: 19
      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: 20
      verificationDate: {isModifier: false, short: When consent verified, type: dateTime, mustSupport: false, array: true, isSummary: false, index: 21}
    required: [verified]
    isSummary: true
  grantor:
    isModifier: false
    short: Who is granting rights according to the policy and rules
    refers: ['http://hl7.org/fhir/StructureDefinition/CareTeam', 'http://hl7.org/fhir/StructureDefinition/HealthcareService', '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: 5
  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
    array: true
    isSummary: false
    index: 10
  dateTime: {isModifier: false, short: When consent was agreed to, type: dateTime, mustSupport: false, isSummary: true, index: 4}
  manager:
    isModifier: false
    short: Consent workflow management
    refers: ['http://hl7.org/fhir/StructureDefinition/HealthcareService', 'http://hl7.org/fhir/StructureDefinition/Organization', 'http://hl7.org/fhir/StructureDefinition/Patient', 'http://hl7.org/fhir/StructureDefinition/Practitioner']
    type: Reference
    mustSupport: false
    array: true
    isSummary: false
    index: 7
  status:
    isModifier: true
    short: draft | active | inactive | not-done | entered-in-error | unknown
    index: 1
    type: code
    mustSupport: false
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/consent-state-codes|5.0.0-ballot'}
    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
  identifier: {isModifier: false, short: Identifier for this record (external references), type: Identifier, mustSupport: false, array: true, isSummary: true, index: 0}
  grantee:
    isModifier: false
    short: Who is agreeing to the policy and rules
    refers: ['http://hl7.org/fhir/StructureDefinition/CareTeam', 'http://hl7.org/fhir/StructureDefinition/HealthcareService', '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
  policyText:
    isModifier: false
    short: Human Readable Policy
    refers: ['http://hl7.org/fhir/StructureDefinition/DocumentReference']
    type: Reference
    mustSupport: false
    array: true
    isSummary: false
    index: 15
  subject:
    isModifier: false
    short: Who the consent applies to
    refers: ['http://hl7.org/fhir/StructureDefinition/Group', 'http://hl7.org/fhir/StructureDefinition/Patient', 'http://hl7.org/fhir/StructureDefinition/Practitioner']
    type: Reference
    mustSupport: false
    isSummary: true
    index: 3
package_version: 5.0.0-ballot
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/Consent
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: 5.0.0-ballot
required: [status]