description: Base StructureDefinition for Consent Resource
package_name: hl7.fhir.core
derivation: specialization
name: Consent
type: Consent
elements:
  patient:
    short: Who the consent applies to
    refers: ['http://hl7.org/fhir/StructureDefinition/Patient']
    comments: Commonly, the patient the consent pertains to is the author, but for young and old people, it may be some other person.
    type: Reference
    isSummary: true
    index: 5
  category: {short: Classification of the consent statement - for indexing/retrieval, type: CodeableConcept, array: true, isSummary: true, index: 2}
  except:
    short: Additional rule -  addition or removal of permissions
    type: BackboneElement
    array: true
    isSummary: true
    index: 19
    elements:
      purpose: {short: Context of activities covered by this exception, comments: 'E.g. if the purpose is ''research'', then the operational context must be research, in order for the consent to apply. Not all of the security labels make sense for use in this element (may define a narrower value set?).', type: Coding, array: true, isSummary: true, index: 27}
      type: {short: deny | permit, type: code, isSummary: true, index: 20}
      class: {short: 'e.g. Resource Type, Profile, or CDA etc', comments: Multiple types are or'ed together. The intention of the contentType element is that the codes refer to profiles or document types defined in a standard or an implementation guide somewhere., type: Coding, array: true, isSummary: true, index: 28}
      code: {short: 'e.g. LOINC or SNOMED CT code, etc in the content', comments: Typical use of this is a Document code with class = CDA., type: Coding, array: true, isSummary: true, index: 29}
      action: {short: Actions controlled by this exception, comments: 'Note that this is the direct action (not the grounds for the action covered in the purpose element). At present, the only action in the understood and tested scope of this resource is ''read''.', type: CodeableConcept, array: true, meaningWhenMissing: all actions, isSummary: true, index: 25}
      period: {short: Timeframe for data controlled by this exception, comments: This has a different sense to the Consent.period - that is when the consent agreement holds. This is the time period of the data that is controlled by the agreement., type: Period, isSummary: true, index: 21}
      securityLabel: {short: Security Labels that define affected resources, comments: 'If the consent specifies a security label of "R" then it applies to all resources that are labelled "R" or lower. E.g. for Confidentiality, it''s a high water mark. For other kinds of security labels, subsumption logic applies. Not all of the security labels make sense for use in this element (may define a narrower value set?).', type: Coding, array: true, isSummary: true, index: 26}
      actor:
        short: Who|what controlled by this exception (or group, by role)
        type: BackboneElement
        array: true
        meaningWhenMissing: There is no specific actor associated with the exception
        isSummary: true
        index: 22
        elements:
          role: {type: CodeableConcept, short: How the actor is/was involved, index: 23}
          reference:
            type: Reference
            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/RelatedPerson']
            index: 24
        required: [role, reference]
      data:
        short: Data controlled by this exception
        type: BackboneElement
        array: true
        meaningWhenMissing: all data
        isSummary: true
        index: 30
        elements:
          meaning: {short: instance | related | dependents, type: code, isSummary: true, index: 31}
          reference:
            short: The actual data reference
            refers: ['http://hl7.org/fhir/StructureDefinition/Resource']
            type: Reference
            isSummary: true
            index: 32
        required: [meaning, reference]
    required: [type]
  purpose: {short: Context of activities for which the agreement is made, comments: 'This element is for discoverability / documentation, and does not modify or qualify the policy (e.g. the policy itself describes the purposes for which it applies).', type: Coding, array: true, isSummary: true, index: 18}
  recipient:
    short: Whose access is controlled by the policy
    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/RelatedPerson']
    comments: The Consent recipient is the person/organization who is being granted or denied permission according to the stated policy.
    type: Reference
    array: true
    meaningWhenMissing: There is no specific actor who is the focus of the consent
    isSummary: true
    index: 17
  sourceAttachment: {short: Source from which this consent is taken, comments: 'The source can be contained inline (Attachment), referenced directly (Consent), referenced in a consent repository (DocumentReference), or simply by an identifier (Identifier), e.g. a CDA document id.', type: Attachment, choiceOf: source, isSummary: true, index: 10}
  organization:
    short: Organization that manages the consent
    refers: ['http://hl7.org/fhir/StructureDefinition/Organization']
    type: Reference
    isSummary: true
    index: 7
  source:
    short: Source from which this consent is taken
    comments: The source can be contained inline (Attachment), referenced directly (Consent), referenced in a consent repository (DocumentReference), or simply by an identifier (Identifier), e.g. a CDA document id.
    choices: [sourceAttachment, sourceIdentifier, sourceReference, sourceReference, sourceReference, sourceReference]
    isSummary: true
    index: 9
  policy: {short: Policy that this consents to, comments: 'If the policy reference is not known, the resource cannot be processed. Where the reference is absent, there is no particular policy other than what is expressed directly in the consent resource.', type: uri, isSummary: true, index: 16}
  sourceReference:
    short: Source from which this consent is taken
    refers: ['http://hl7.org/fhir/StructureDefinition/Consent']
    comments: The source can be contained inline (Attachment), referenced directly (Consent), referenced in a consent repository (DocumentReference), or simply by an identifier (Identifier), e.g. a CDA document id.
    type: Reference
    choiceOf: source
    isSummary: true
    index: 12
  dateTime: {short: When this Consent was created or indexed, comments: 'This is not the time of the original consent, but the time that this statement was made or derived.', type: dateTime, isSummary: true, index: 3}
  consentor:
    short: Who is agreeing to the policy and exceptions
    refers: ['http://hl7.org/fhir/StructureDefinition/Organization', 'http://hl7.org/fhir/StructureDefinition/Patient', 'http://hl7.org/fhir/StructureDefinition/Practitioner', 'http://hl7.org/fhir/StructureDefinition/RelatedPerson']
    comments: Commonly, the patient the consent pertains to is the consentor, but particularly for young and old people, it may be some other person - e.g. a legal guardian.
    type: Reference
    array: true
    isSummary: true
    index: 6
  status: {isModifier: true, short: draft | proposed | active | rejected | inactive | entered-in-error, comments: This is the status of this consent at the time it was issued / created / indexed., type: code, isSummary: true, index: 1}
  sourceIdentifier: {short: Source from which this consent is taken, comments: 'The source can be contained inline (Attachment), referenced directly (Consent), referenced in a consent repository (DocumentReference), or simply by an identifier (Identifier), e.g. a CDA document id.', type: Identifier, choiceOf: source, isSummary: true, index: 11}
  identifier: {short: Identifier for this record (external references), comments: This identifier is identifies this copy of the consent. Where this identifier is also used elsewhere as the identifier for a consent record (e.g. a CDA consent document) then the consent details are expected to be the same., type: Identifier, isSummary: true, index: 0}
  period: {short: Period that this consent applies, comments: This can be a subset of the period of the original statement., type: Period, meaningWhenMissing: all date ranges included, isSummary: true, index: 4}
package_version: 1.8.0
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/Consent
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: null
required: [status, policy, patient]