profile-Consent
type: StructureDefinition
node role: treeRoot
id:
  v: profile-Consent
text:
  status:
    v: extensions
  div:
    v: Generated Narrative: StructureDefinition profile-Consent Name Flags Card. Type Description & Constraints<img src="[binary]" alt="doco" style="background-color: inherit"/> Consent 0..* Consent A healthcare consumer's policy choices to permits or denies recipients or roles to perform actions for specific purposes and periods of time #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:period 0..1 Period R5: Effective period for this Consent (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.period #xD; extension:grantor 0..* Reference(Cross-version Profile for R5.CareTeam for use in FHIR STU3(0.1.0) | CareTeam | Cross-version Profile for R5.HealthcareService for use in FHIR STU3(0.1.0) | HealthcareService | Cross-version Profile for R5.Organization for use in FHIR STU3(0.1.0) | Organization | Cross-version Profile for R5.Patient for use in FHIR STU3(0.1.0) | Patient | Cross-version Profile for R5.Practitioner for use in FHIR STU3(0.1.0) | Practitioner | Cross-version Profile for R5.RelatedPerson for use in FHIR STU3(0.1.0) | RelatedPerson | Cross-version Profile for R5.PractitionerRole for use in FHIR STU3(0.1.0) | PractitionerRole) R5: Who is granting rights according to the policy and rules (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor #xD; extension:manager 0..* Reference(Cross-version Profile for R5.HealthcareService for use in FHIR STU3(0.1.0) | HealthcareService | Cross-version Profile for R5.Organization for use in FHIR STU3(0.1.0) | Organization | Cross-version Profile for R5.Patient for use in FHIR STU3(0.1.0) | Patient | Cross-version Profile for R5.Practitioner for use in FHIR STU3(0.1.0) | Practitioner) R5: Consent workflow management (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.manager #xD; extension:controller 0..* Reference(Cross-version Profile for R5.HealthcareService for use in FHIR STU3(0.1.0) | HealthcareService | Cr…
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-wg
    l: structuredefinition-wg
  value: Code
    v: fhir
extension:
  extension:
    url:
      v: packageId
      l: packageId
    value: Id
      v: hl7.fhir.uv.xver-r5.r3
  extension:
    url:
      v: version
      l: version
    value: String
      v: 0.1.0
  url:
    v: http://hl7.org/fhir/StructureDefinition/package-source
    l: package-source
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm
    l: structuredefinition-fmm
  value: Integer
    v: 0
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom
        l: structuredefinition-conformance-derivedFrom
      value: Uri
        v: http://hl7.org/fhir/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r5.r3
        l: hl7.fhir.uv.xver-r5.r3
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
    l: structuredefinition-standards-status
  value: Code
    v: trial-use
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom
        l: structuredefinition-conformance-derivedFrom
      value: Uri
        v: http://hl7.org/fhir/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r5.r3
        l: hl7.fhir.uv.xver-r5.r3
url:
  v: http://hl7.org/fhir/5.0/StructureDefinition/profile-Consent
  l: profile-Consent
version:
  v: 0.1.0
name:
  v: Profile_R5_Consent_R3
title:
  v: Cross-version Profile for R5.Consent for use in FHIR STU3
status:
  v: active
experimental:
  v: false
date:
  v: 2026-03-17T16:05:12.9201087-05:00
publisher:
  v: FHIR Infrastructure
contact:
  name:
    v: FHIR Infrastructure
  telecom:
    system:
      v: url
    value:
      v: http://www.hl7.org/Special/committees/fiwg
description:
  v: This cross-version profile allows R5 Consent content to be represented via FHIR STU3 Consent resources.
jurisdiction:
  coding:
    system:
      v: http://unstats.un.org/unsd/methods/m49/m49.htm
      l: m49.htm
    code:
      v: 001
    display:
      v: World
fhir version:
  v: 3.0.2
mapping:
  identity:
    v: rim
  uri:
    v: http://hl7.org/v3
    l: v3
  name:
    v: RIM Mapping
mapping:
  identity:
    v: w5
  uri:
    v: http://hl7.org/fhir/w5
    l: w5
  name:
    v: W5 Mapping
mapping:
  identity:
    v: v2
  uri:
    v: http://hl7.org/v2
    l: v2
  name:
    v: HL7 v2 Mapping
kind:
  v: resource
abstract:
  v: false
type:
  v: Consent
base definition:
  v: http://hl7.org/fhir/StructureDefinition/Consent
  l: Consent
derivation:
  v: constraint
snapshot:
  element:
    id:
      v: Consent
    path:
      v: Consent
    short:
      v: A healthcare consumer's policy choices to permits or denies recipients or roles to perform actions for specific purposes and periods of time
    definition:
      v: A record of a healthcare consumer’s policy 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.
    comment:
      v: Broadly, there are 3 key areas of consent for patients: Consent around sharing information (aka Privacy Consent Directive - Authorization to Collect, Use, or Disclose information), consent for specific treatment, or kinds of treatment, and general advance care directives.
    min:
      v: 0
    max:
      v: *
    base:
      path:
        v: Consent
      min:
        v: 0
      max:
        v: *
    constraint:
      key:
        v: dom-2
      severity:
        v: error
      human:
        v: If the resource is contained in another resource, it SHALL NOT contain nested Resources
      expression:
        v: contained.contained.empty()
      xpath:
        v: not(parent::f:contained and f:contained)
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        l: DomainResource
    constraint:
      key:
        v: dom-1
      severity:
        v: error
      human:
        v: If the resource is contained in another resource, it SHALL NOT contain any narrative
      expression:
        v: contained.text.empty()
      xpath:
        v: not(parent::f:contained and f:text)
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        l: DomainResource
    constraint:
      key:
        v: dom-4
      severity:
        v: error
      human:
        v: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
      expression:
        v: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
      xpath:
        v: not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        l: DomainResource
    constraint:
      key:
        v: dom-3
      severity:
        v: error
      human:
        v: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
      expression:
        v: contained.where(('#'+id in %resource.descendants().reference).not()).empty()

v: not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))

key:
  v: ppc-1
severity:
  v: error
human:
  v: Either a Policy or PolicyRule
expression:
  v: policy.exists() or policyRule.exists()
xpath:
  v: exists(f:policy) or exists(f:policyRule)
source:
  v: http://hl7.org/fhir/StructureDefinition/Consent
  l: Consent

identity:
  v: rim
map:
  v: Entity. Role, or Act

identity:
  v: rim
map:
  v: FinancialConsent

identity:
  v: w5
map:
  v: infrastructure.information

id:
  v: Consent.id
path:
  v: Consent.id
short:
  v: Logical id of this artifact
definition:
  v: The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
comment:
  v: The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Resource.id
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: id
    l: id
is summary:
  v: true

id:
  v: Consent.meta
path:
  v: Consent.meta
short:
  v: Metadata about the resource
definition:
  v: The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Resource.meta
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Meta
    l: Meta
is summary:
  v: true

id:
  v: Consent.implicitRules
path:
  v: Consent.implicitRules
short:
  v: A set of rules under which this content was created
definition:
  v: A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.
comment:
  v: Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Resource.implicitRules
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: uri
    l: uri
is modifier:
  v: true
is summary:
  v: true

id:
  v: Consent.language
path:
  v: Consent.language
short:
  v: Language of the resource content
definition:
  v: The base language in which the resource is written.
comment:
  v: Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Resource.language
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet
      l: elementdefinition-maxValueSet
    value: Reference
      l: 3.0
      l: .2
      reference:
        v: http://hl7.org/fhir/ValueSet/all-languages|3.0.2
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: Language
  strength:
    v: extensible
  description:
    v: A human language.
  value set: Reference
    l: 3.0
    l: .2
    reference:
      v: http://hl7.org/fhir/ValueSet/languages|3.0.2

id:
  v: Consent.text
path:
  v: Consent.text
short:
  v: Text summary of the resource, for human interpretation
definition:
  v: A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
comment:
  v: Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.
alias:
  v: narrative
alias:
  v: html
alias:
  v: xhtml
alias:
  v: display
min:
  v: 0
max:
  v: 1
base:
  path:
    v: DomainResource.text
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Narrative
    l: Narrative
condition:
  v: dom-1
mapping:
  identity:
    v: rim
  map:
    v: Act.text?

id:
  v: Consent.contained
path:
  v: Consent.contained
short:
  v: Contained, inline Resources
definition:
  v: These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
comment:
  v: This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.
alias:
  v: inline resources
alias:
  v: anonymous resources
alias:
  v: contained resources
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.contained
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Resource
    l: Resource
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Consent.extension
path:
  v: Consent.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  ordered:
    v: false
  rules:
    v: open
short:
  v: Extension
definition:
  v: An Extension
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension

id:
  v: Consent.extension:period
path:
  v: Consent.extension
slice name:
  v: period
short:
  v: R5: Effective period for this Consent (new)
definition:
  v: R5: `Consent.period` (new:Period)
comment:
  v: Element `Consent.period` has a context of Consent based on following the parent source element upwards and mapping to `Consent`. Element `Consent.period` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.period|0.1.0
    l: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.period
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() | (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    l: Extension
is modifier:
  v: false

id:
  v: Consent.extension:grantor
path:
  v: Consent.extension
slice name:
  v: grantor
short:
  v: R5: Who is granting rights according to the policy and rules (new)
definition:
  v: R5: `Consent.grantor` (new:Reference(CareTeam,HealthcareService,Organization,Patient,Practitioner,RelatedPerson,PractitionerRole))
comment:
  v: Element `Consent.grantor` has a context of Consent based on following the parent source element upwards and mapping to `Consent`. Element `Consent.grantor` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor|0.1.0
    l: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() | (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    l: Extension
is modifier:
  v: false

id:
  v: Consent.extension:manager
path:
  v: Consent.extension
slice name:
  v: manager
short:
  v: R5: Consent workflow management (new)
definition:
  v: R5: `Consent.manager` (new:Reference(HealthcareService,Organization,Patient,Practitioner))
comment:
  v: Element `Consent.manager` has a context of Consent based on following the parent source element upwards and mapping to `Consent`. Element `Consent.manager` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.manager|0.1.0
    l: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.manager
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() | (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    l: Extension
is modifier:
  v: false

id:
  v: Consent.extension:controller
path:
  v: Consent.extension
slice name:
  v: controller
short:
  v: R5: Consent Enforcer (new)
definition:
  v: R5: `Consent.controller` (new:Reference(HealthcareService,Organization,Patient,Practitioner))
comment:
  v: Element `Consent.controller` has a context of Consent based on following the parent source element upwards and mapping to `Consent`. Element `Consent.controller` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.controller|0.1.0
    l: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.controller
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() | (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    l: Extension
is modifier:
  v: false

id:
  v: Consent.extension:policyText
path:
  v: Consent.extension
slice name:
  v: policyText
short:
  v: R5: Human Readable Policy (new)
definition:
  v: R5: `Consent.policyText` (new:Reference(DocumentReference))
comment:
  v: Element `Consent.policyText` has a context of Consent based on following the parent source element upwards and mapping to `Consent`. Element `Consent.policyText` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.policyText|0.1.0
    l: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.policyText
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() | (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    l: Extension
is modifier:
  v: false

id:
  v: Consent.extension:verification
path:
  v: Consent.extension
slice name:
  v: verification
short:
  v: R5: Consent Verified by patient or family (new)
definition:
  v: R5: `Consent.verification` (new:BackboneElement)
comment:
  v: Element `Consent.verification` has a context of Consent based on following the parent source element upwards and mapping to `Consent`. Element `Consent.verification` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.verification|0.1.0
    l: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.verification
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() | (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    l: Extension
is modifier:
  v: false

id:
  v: Consent.extension:reference
path:
  v: Consent.extension
slice name:
  v: reference
short:
  v: R5: Resource for the actor (or group, by role)
definition:
  v: R5: `Consent.provision.actor.reference`
comment:
  v: Element `Consent.provision.actor.reference` is mapped to FHIR STU3 element `Consent.actor.reference` as `SourceIsBroaderThanTarget`. Element `Consent.provision.actor.reference` is mapped to FHIR STU3 element `Consent.except.actor.reference` as `SourceIsBroaderThanTarget`. The standard extension `alternate-reference` has been mapped as the representation of FHIR R5 element `Consent.provision.actor.reference` with unmapped reference targets: CareTeam, Device, Group, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/StructureDefinition/alternate-reference
    l: alternate-reference

id:
  v: Consent.extension:reference
path:
  v: Consent.extension
slice name:
  v: reference
short:
  v: R5: The actual data reference additional types
definition:
  v: R5: `Consent.provision.data.reference` additional types from child elements (display, identifier, reference, type)
comment:
  v: Element `Consent.provision.data.reference` is mapped to FHIR STU3 element `Consent.data.reference` as `SourceIsBroaderThanTarget`. Element `Consent.provision.data.reference` is mapped to FHIR STU3 element `Consent.except.data.reference` as `SourceIsBroaderThanTarget`. The mappings for `Consent.provision.data.reference` do not cover the following types based on type expansion: display, identifier, reference, type. The standard extension `alternate-reference` has been mapped as the representation of FHIR R5 element `Consent.provision.data.reference` with unmapped reference targets: Resource.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/StructureDefinition/alternate-reference
    l: alternate-reference

id:
  v: Consent.modifierExtension
path:
  v: Consent.modifierExtension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  ordered:
    v: false
  rules:
    v: open
short:
  v: Extension
definition:
  v: An Extension
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.modifierExtension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
is modifier:
  v: true

id:
  v: Consent.modifierExtension:decision
path:
  v: Consent.modifierExtension
slice name:
  v: decision
short:
  v: R5: deny | permit (new)
definition:
  v: R5: `Consent.decision` (new:code)
comment:
  v: Element `Consent.decision` has a context of Consent based on following the parent source element upwards and mapping to `Consent`. Element `Consent.decision` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: DomainResource.modifierExtension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.decision|0.1.0
    l: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.decision
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() | (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    l: Extension
is modifier:
  v: true

id:
  v: Consent.identifier
path:
  v: Consent.identifier
short:
  v: Identifier for this record (external references)
definition:
  v: Unique identifier for this copy of the Consent Statement.
comment:
  v: 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.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Consent.identifier
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Identifier
    l: Identifier
example:
  label:
    v: General
  value: Identifier
    system:
      v: urn:ietf:rfc:3986
      l: 3986
    value:
      v: Local eCMS identifier
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: .id
mapping:
  identity:
    v: w5
  map:
    v: id

id:
  v: Consent.status
path:
  v: Consent.status
short:
  v: draft | proposed | active | rejected | inactive | entered-in-error
definition:
  v: Indicates the current state of this consent.
comment:
  v: This element is labeled as a modifier because the status contains the codes rejected and entered-in-error that mark the Consent as not currently valid.
requirements:
  v: The Consent Directive that is pointed to might be in various lifecycle states, e.g., a revoked Consent Directive.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Consent.status
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: code
    l: code
is modifier:
  v: true
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: ConsentState
  strength:
    v: required
  description:
    v: Indicates the state of the consent
  value set: Reference
    l: 3.0
    l: .2
    reference:
      v: http://hl7.org/fhir/ValueSet/consent-state-codes|3.0.2
mapping:
  identity:
    v: v2
  map:
    v: HL7 Table 0498 - Consent Status
mapping:
  identity:
    v: rim
  map:
    v: .statusCode
mapping:
  identity:
    v: w5
  map:
    v: status

id:
  v: Consent.status.id
path:
  v: Consent.status.id
representation:
  v: xmlAttr
short:
  v: xml:id (or equivalent in JSON)
definition:
  v: unique id for the element within a resource (for internal references)
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string

id:
  v: Consent.status.extension
path:
  v: Consent.status.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  ordered:
    v: false
  rules:
    v: open
short:
  v: Extension
definition:
  v: An Extension
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension

id:
  v: Consent.status.extension:status
path:
  v: Consent.status.extension
slice name:
  v: status
short:
  v: R5: draft | active | inactive | not-done | entered-in-error | unknown
definition:
  v: R5: `Consent.status`
comment:
  v: Element `Consent.status` is mapped to FHIR STU3 element `Consent.status` as `SourceIsBroaderThanTarget`. The target context `Consent.status` is a modifier element, so this extension does not need to be defined as a modifier. This element is labeled as a modifier because the status contains the codes rejected and entered-in-error that mark the Consent as not currently valid.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.status|0.1.0
    l: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.status
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() | (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    l: Extension
is modifier:
  v: false

id:
  v: Consent.status.value
path:
  v: Consent.status.value
representation:
  v: xmlAttr
short:
  v: Primitive value for code
definition:
  v: Primitive value for code
min:
  v: 0
max:
  v: 1
base:
  path:
    v: string.value
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-regex
      l: structuredefinition-regex
    value: String
      v: [^\s]+([\s]?[^\s]+)*
  code:
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/structuredefinition-json-type
        l: structuredefinition-json-type
      value: String
        v: string
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/structuredefinition-xml-type
        l: structuredefinition-xml-type
      value: String
        v: xsd:token
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/structuredefinition-rdf-type
        l: structuredefinition-rdf-type
      value: String
        v: xsd:token

id:
  v: Consent.category
path:
  v: Consent.category
short:
  v: Classification of the consent statement - for indexing/retrieval
definition:
  v: A classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Consent.category
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: ConsentCategory
  strength:
    v: example
  description:
    v: A classification of the type of consents found in a consent statement
  value set: Reference
    l: 3.0
    l: .2
    reference:
      v: http://hl7.org/fhir/ValueSet/consent-category|3.0.2
mapping:
  identity:
    v: rim
  map:
    v: CNTRCT
mapping:
  identity:
    v: w5
  map:
    v: class

id:
  v: Consent.patient
path:
  v: Consent.patient
short:
  v: Who the consent applies to
definition:
  v: The patient/healthcare consumer to whom this consent applies.
comment:
  v: Commonly, the patient the consent pertains to is the author, but for young and old people, it may be some other person.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Consent.patient
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Patient
    l: Patient
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: Role
mapping:
  identity:
    v: w5
  map:
    v: who.focus

id:
  v: Consent.patient.id
path:
  v: Consent.patient.id
representation:
  v: xmlAttr
short:
  v: xml:id (or equivalent in JSON)
definition:
  v: unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Consent.patient.extension
path:
  v: Consent.patient.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  ordered:
    v: false
  rules:
    v: open
short:
  v: Extension
definition:
  v: An Extension
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension

id:
  v: Consent.patient.extension:subject
path:
  v: Consent.patient.extension
slice name:
  v: subject
short:
  v: R5: subject
definition:
  v: R5: `Consent.subject`
comment:
  v: Element `Consent.subject` is mapped to FHIR STU3 element `Consent.patient` as `SourceIsBroaderThanTarget`. The standard extension `alternate-reference` has been mapped as the representation of FHIR R5 element `Consent.subject` with unmapped reference targets: Group, Patient, Practitioner.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/StructureDefinition/alternate-reference
    l: alternate-reference

id:
  v: Consent.patient.reference
path:
  v: Consent.patient.reference
short:
  v: Literal reference, Relative, internal or absolute URL
definition:
  v: A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
comment:
  v: Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Reference.reference
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
condition:
  v: ref-1
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Consent.patient.identifier
path:
  v: Consent.patient.identifier
short:
  v: Logical reference, when literal reference is not known
definition:
  v: An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
comment:
  v: When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Reference.identifier
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Identifier
    l: Identifier
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: .identifier

id:
  v: Consent.patient.display
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable
    l: elementdefinition-translatable
  value: Boolean
    v: true
path:
  v: Consent.patient.display
short:
  v: Text alternative for the resource
definition:
  v: Plain text narrative that identifies the resource in addition to the resource reference.
comment:
  v: This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Reference.display
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Consent.period
path:
  v: Consent.period
short:
  v: Period that this consent applies
definition:
  v: Relevant time or time-period when this Consent is applicable.
comment:
  v: This can be a subset of the period of the original statement.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Consent.period
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Period
    l: Period
meaning when missing:
  v: all date ranges included
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: FinancialConsent activityTime
mapping:
  identity:
    v: w5
  map:
    v: when.done

id:
  v: Consent.dateTime
path:
  v: Consent.dateTime
short:
  v: When this Consent was created or indexed
definition:
  v: When this Consent was issued / created / indexed.
comment:
  v: This is not the time of the original consent, but the time that this statement was made or derived.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Consent.dateTime
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: dateTime
    l: dateTime
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: FinancialConsent effectiveTime
mapping:
  identity:
    v: w5
  map:
    v: when.recorded

id:
  v: Consent.consentingParty
path:
  v: Consent.consentingParty
short:
  v: Who is agreeing to the policy and exceptions
definition:
  v: Either the Grantor, which is the entity responsible for granting the rights listed in a Consent Directive or the Grantee, which is the entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations and enforcement of prohibitions.
comment:
  v: 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.
alias:
  v: consentor
min:
  v: 0
max:
  v: *
base:
  path:
    v: Consent.consentingParty
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Organization
    l: Organization
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Patient
    l: Patient
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Practitioner
    l: Practitioner
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/RelatedPerson
    l: RelatedPerson
is summary:
  v: true
mapping:
  identity:
    v: w5
  map:
    v: who.actor

id:
  v: Consent.consentingParty.id
path:
  v: Consent.consentingParty.id
representation:
  v: xmlAttr
short:
  v: xml:id (or equivalent in JSON)
definition:
  v: unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Consent.consentingParty.extension
path:
  v: Consent.consentingParty.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  ordered:
    v: false
  rules:
    v: open
short:
  v: Extension
definition:
  v: An Extension
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension

id:
  v: Consent.consentingParty.extension:grantee
path:
  v: Consent.consentingParty.extension
slice name:
  v: grantee
short:
  v: R5: Who is agreeing to the policy and rules
definition:
  v: R5: `Consent.grantee`
comment:
  v: Element `Consent.grantee` is mapped to FHIR STU3 element `Consent.consentingParty` as `SourceIsBroaderThanTarget`. The standard extension `alternate-reference` has been mapped as the representation of FHIR R5 element `Consent.grantee` with unmapped reference targets: CareTeam, HealthcareService, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson. In a fully computable consent, both grantee and grantor will be listed as actors within the consent. The Grantee and Grantor elements are for ease of search only.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/StructureDefinition/alternate-reference
    l: alternate-reference

id:
  v: Consent.consentingParty.reference
path:
  v: Consent.consentingParty.reference
short:
  v: Literal reference, Relative, internal or absolute URL
definition:
  v: A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
comment:
  v: Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Reference.reference
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
condition:
  v: ref-1
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Consent.consentingParty.identifier
path:
  v: Consent.consentingParty.identifier
short:
  v: Logical reference, when literal reference is not known
definition:
  v: An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
comment:
  v: When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Reference.identifier
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Identifier
    l: Identifier
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: .identifier

id:
  v: Consent.consentingParty.display
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable
    l: elementdefinition-translatable
  value: Boolean
    v: true
path:
  v: Consent.consentingParty.display
short:
  v: Text alternative for the resource
definition:
  v: Plain text narrative that identifies the resource in addition to the resource reference.
comment:
  v: This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Reference.display
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Consent.actor
path:
  v: Consent.actor
short:
  v: Who|what controlled by this consent (or group, by role)
definition:
  v: Who or what is controlled by this consent. Use group to identify a set of actors by some property they share (e.g. 'admitting officers').
min:
  v: 0
max:
  v: *
base:
  path:
    v: Consent.actor
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: BackboneElement
    l: BackboneElement
meaning when missing:
  v: There is no specific actor associated with the consent
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() | (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is summary:
  v: true
mapping:
  identity:
    v: w5
  map:
    v: who.actor

id:
  v: Consent.actor.id
path:
  v: Consent.actor.id
representation:
  v: xmlAttr
short:
  v: xml:id (or equivalent in JSON)
definition:
  v: unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Consent.actor.extension
path:
  v: Consent.actor.extension
short:
  v: Additional Content defined by implementations
definition:
  v: May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Consent.actor.modifierExtension
path:
  v: Consent.actor.modifierExtension
short:
  v: Extensions that cannot be ignored
definition:
  v: May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
alias:
  v: extensions
alias:
  v: user content
alias:
  v: modifiers
min:
  v: 0
max:
  v: *
base:
  path:
    v: BackboneElement.modifierExtension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
is modifier:
  v: true
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Consent.actor.role
path:
  v: Consent.actor.role
short:
  v: How the actor is involved
definition:
  v: How the individual is involved in the resources content that is described in the consent.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Consent.actor.role
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: ConsentActorRole
  strength:
    v: extensible
  description:
    v: How an actor is involved in the consent considerations
  value set: Reference
    l: 1.8
    l: .0
    reference:
      v: http://hl7.org/fhir/ValueSet/security-role-type|1.8.0

id:
  v: Consent.actor.reference
path:
  v: Consent.actor.reference
short:
  v: Resource for the actor (or group, by role)
definition:
  v: The resource that identifies the actor. To identify a actors by type, use group to identify a set of actors by some property they share (e.g. 'admitting officers').
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Consent.actor.reference
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Device
    l: Device
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Group
    l: Group
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/CareTeam
    l: CareTeam
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Organization
    l: Organization
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Patient
    l: Patient
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Practitioner
    l: Practitioner
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/RelatedPerson
    l: RelatedPerson

id:
  v: Consent.action
path:
  v: Consent.action
short:
  v: Actions controlled by this consent
definition:
  v: Actions controlled by this consent.
comment:
  v: 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'.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Consent.action
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
meaning when missing:
  v: all actions
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: ConsentAction
  strength:
    v: example
  description:
    v: Detailed codes for the consent action.
  value set: Reference
    l: 3.0
    l: .2
    reference:
      v: http://hl7.org/fhir/ValueSet/consent-action|3.0.2

id:
  v: Consent.organization
path:
  v: Consent.organization
short:
  v: Custodian of the consent
definition:
  v: The organization that manages the consent, and the framework within which it is executed.
alias:
  v: custodian
min:
  v: 0
max:
  v: *
base:
  path:
    v: Consent.organization
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Organization
    l: Organization
is summary:
  v: true
mapping:
  identity:
    v: w5
  map:
    v: who.witness

id:
  v: Consent.source[x]
path:
  v: Consent.source[x]
short:
  v: Source from which this consent is taken
definition:
  v: The source on which this consent statement is based. The source might be a scanned original paper form, or a reference to a consent that links back to such a source, a reference to a document repository (e.g. XDS) that stores the original consent document.
comment:
  v: 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.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Consent.source[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Attachment
    l: Attachment
type:
  code:
    v: Identifier
    l: Identifier
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Consent
    l: Consent
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/DocumentReference
    l: DocumentReference
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Contract
    l: Contract
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse
    l: QuestionnaireResponse
is summary:
  v: true

id:
  v: Consent.source[x].id
path:
  v: Consent.source[x].id
representation:
  v: xmlAttr
short:
  v: xml:id (or equivalent in JSON)
definition:
  v: unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Consent.source[x].extension
path:
  v: Consent.source[x].extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  ordered:
    v: false
  rules:
    v: open
short:
  v: Extension
definition:
  v: An Extension
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension

id:
  v: Consent.source[x].extension:alternateReference
path:
  v: Consent.source[x].extension
slice name:
  v: alternateReference
short:
  v: R5: sourceReference
definition:
  v: R5: `Consent.sourceReference`
comment:
  v: Element `Consent.sourceReference` is mapped to FHIR STU3 element `Consent.source[x]` as `SourceIsBroaderThanTarget`. The standard extension `alternate-reference` has been mapped as the representation of FHIR R5 element `Consent.sourceReference` with unmapped reference targets: Consent, Contract, DocumentReference, QuestionnaireResponse. Source element `Consent.sourceReference` has unmapped reference types. While the target element `Consent.source[x]` is a choice type and does not allow extensions, the `alternate-reference` extension can be applied to Reference values within it. 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.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/StructureDefinition/alternate-reference
    l: alternate-reference

id:
  v: Consent.policy
path:
  v: Consent.policy
short:
  v: Policies covered by this consent
definition:
  v: The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Consent.policy
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: BackboneElement
    l: BackboneElement
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() | (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element

id:
  v: Consent.policy.id
path:
  v: Consent.policy.id
representation:
  v: xmlAttr
short:
  v: xml:id (or equivalent in JSON)
definition:
  v: unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Consent.policy.extension
path:
  v: Consent.policy.extension
short:
  v: Additional Content defined by implementations
definition:
  v: May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Consent.policy.modifierExtension
path:
  v: Consent.policy.modifierExtension
short:
  v: Extensions that cannot be ignored
definition:
  v: May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
alias:
  v: extensions
alias:
  v: user content
alias:
  v: modifiers
min:
  v: 0
max:
  v: *
base:
  path:
    v: BackboneElement.modifierExtension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
is modifier:
  v: true
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Consent.policy.authority
path:
  v: Consent.policy.authority
short:
  v: Enforcement source for policy
definition:
  v: Entity or Organization having regulatory jurisdiction or accountability for enforcing policies pertaining to Consent Directives.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Consent.policy.authority
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: uri
    l: uri
condition:
  v: ppc-1

id:
  v: Consent.policy.uri
path:
  v: Consent.policy.uri
short:
  v: Specific policy covered by this consent
definition:
  v: The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law.
comment:
  v: This element is for discoverability / documentation, and does not modify or qualify the policy rules.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Consent.policy.uri
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: uri
    l: uri
condition:
  v: ppc-1

id:
  v: Consent.policyRule
path:
  v: Consent.policyRule
short:
  v: Policy that this consents to
definition:
  v: A referece to the specific computable policy.
comment:
  v: 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.
requirements:
  v: Might be a unique identifier of a policy set in XACML, or other rules engine.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Consent.policyRule
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: uri
    l: uri
condition:
  v: ppc-1
is summary:
  v: true

id:
  v: Consent.policyRule.id
path:
  v: Consent.policyRule.id
representation:
  v: xmlAttr
short:
  v: xml:id (or equivalent in JSON)
definition:
  v: unique id for the element within a resource (for internal references)
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string

id:
  v: Consent.policyRule.extension
path:
  v: Consent.policyRule.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  ordered:
    v: false
  rules:
    v: open
short:
  v: Extension
definition:
  v: An Extension
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension

id:
  v: Consent.policyRule.extension:regulatoryBasis
path:
  v: Consent.policyRule.extension
slice name:
  v: regulatoryBasis
short:
  v: R5: Regulations establishing base Consent additional types
definition:
  v: R5: `Consent.regulatoryBasis` additional types (CodeableConcept) additional types from child elements (coding, text)
comment:
  v: Element `Consent.regulatoryBasis` is mapped to FHIR STU3 element `Consent.policyRule` as `SourceIsBroaderThanTarget`. The mappings for `Consent.regulatoryBasis` do not cover the following types: CodeableConcept. The mappings for `Consent.regulatoryBasis` do not cover the following types based on type expansion: coding, text.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.regulatoryBasis|0.1.0
    l: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.regulatoryBasis
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() | (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    l: Extension
is modifier:
  v: false

id:
  v: Consent.policyRule.value
path:
  v: Consent.policyRule.value
representation:
  v: xmlAttr
short:
  v: Primitive value for uri
definition:
  v: The actual value
min:
  v: 0
max:
  v: 1
base:
  path:
    v: uri.value
  min:
    v: 0
  max:
    v: 1
type:
  code:
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/structuredefinition-json-type
        l: structuredefinition-json-type
      value: String
        v: string
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/structuredefinition-xml-type
        l: structuredefinition-xml-type
      value: String
        v: xsd:anyURI
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/structuredefinition-rdf-type
        l: structuredefinition-rdf-type
      value: String
        v: xsd:string

id:
  v: Consent.securityLabel
path:
  v: Consent.securityLabel
short:
  v: Security Labels that define affected resources
definition:
  v: A set of security labels that define which resources are controlled by this consent. If more than one label is specified, all resources must have all the specified labels.
comment:
  v: If the consent specifies a security label of "R" then it applies to all resources that are labeled "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?).
min:
  v: 0
max:
  v: *
base:
  path:
    v: Consent.securityLabel
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Coding
    l: Coding
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: SecurityLabels
  strength:
    v: extensible
  description:
    v: Security Labels from the Healthcare Privacy and Security Classification System.
  value set: Reference
    l: 3.0
    l: .2
    reference:
      v: http://hl7.org/fhir/ValueSet/security-labels|3.0.2

id:
  v: Consent.purpose
path:
  v: Consent.purpose
short:
  v: Context of activities for which the agreement is made
definition:
  v: The context of the activities a user is taking - why the user is accessing the data - that are controlled by this consent.
comment:
  v: 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).
min:
  v: 0
max:
  v: *
base:
  path:
    v: Consent.purpose
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Coding
    l: Coding
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: PurposeOfUse
  strength:
    v: extensible
  description:
    v: What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels
  value set: Reference
    l: 2014
    l: -03
    l: -26
    reference:
      v: http://hl7.org/fhir/ValueSet/v3-PurposeOfUse|2014-03-26

id:
  v: Consent.dataPeriod
path:
  v: Consent.dataPeriod
short:
  v: Timeframe for data controlled by this consent
definition:
  v: Clinical or Operational Relevant period of time that bounds the data controlled by this consent.
comment:
  v: 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.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Consent.dataPeriod
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Period
    l: Period
is summary:
  v: true

id:
  v: Consent.data
path:
  v: Consent.data
short:
  v: Data controlled by this consent
definition:
  v: The resources controlled by this consent, if specific resources are referenced.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Consent.data
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: BackboneElement
    l: BackboneElement
meaning when missing:
  v: all data
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() | (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: Role

id:
  v: Consent.data.id
path:
  v: Consent.data.id
representation:
  v: xmlAttr
short:
  v: xml:id (or equivalent in JSON)
definition:
  v: unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Consent.data.extension
path:
  v: Consent.data.extension
short:
  v: Additional Content defined by implementations
definition:
  v: May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Consent.data.modifierExtension
path:
  v: Consent.data.modifierExtension
short:
  v: Extensions that cannot be ignored
definition:
  v: May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
alias:
  v: extensions
alias:
  v: user content
alias:
  v: modifiers
min:
  v: 0
max:
  v: *
base:
  path:
    v: BackboneElement.modifierExtension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
is modifier:
  v: true
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Consent.data.meaning
path:
  v: Consent.data.meaning
short:
  v: instance | related | dependents | authoredby
definition:
  v: How the resource reference is interpreted when testing consent restrictions.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Consent.data.meaning
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: code
    l: code
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: ConsentDataMeaning
  strength:
    v: required
  description:
    v: How a resource reference is interpreted when testing consent restrictions
  value set: Reference
    l: 3.0
    l: .2
    reference:
      v: http://hl7.org/fhir/ValueSet/consent-data-meaning|3.0.2

id:
  v: Consent.data.reference
path:
  v: Consent.data.reference
short:
  v: The actual data reference
definition:
  v: A reference to a specific resource that defines which resources are covered by this consent.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Consent.data.reference
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Resource
    l: Resource
is summary:
  v: true

id:
  v: Consent.except
path:
  v: Consent.except
short:
  v: Additional rule - addition or removal of permissions
definition:
  v: An exception to the base policy of this consent. An exception can be an addition or removal of access permissions.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Consent.except
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: BackboneElement
    l: BackboneElement
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() | (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is summary:
  v: true

id:
  v: Consent.except.id
path:
  v: Consent.except.id
representation:
  v: xmlAttr
short:
  v: xml:id (or equivalent in JSON)
definition:
  v: unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Consent.except.extension
path:
  v: Consent.except.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  ordered:
    v: false
  rules:
    v: open
short:
  v: Extension
definition:
  v: An Extension
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension

id:
  v: Consent.except.extension:expression
path:
  v: Consent.except.extension
slice name:
  v: expression
short:
  v: R5: A computable expression of the consent (new)
definition:
  v: R5: `Consent.provision.expression` (new:Expression)
comment:
  v: Element `Consent.provision.expression` has a context of Consent.except based on following the parent source element upwards and mapping to `Consent`. Element `Consent.provision.expression` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). Constraining the expression type for a specific implementation via profile is recommended
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.provision.expression|0.1.0
    l: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.provision.expression
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() | (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    l: Extension
is modifier:
  v: false

id:
  v: Consent.except.extension:provision
path:
  v: Consent.except.extension
slice name:
  v: provision
short:
  v: R5: Nested Exception Provisions (new)
definition:
  v: R5: `Consent.provision.provision` (new:Consent.provision)
comment:
  v: Element `Consent.provision.provision` has a context of Consent.except based on following the parent source element upwards and mapping to `Consent`. Element `Consent.provision.provision` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.provision|0.1.0
    l: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.provision
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() | (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    l: Extension
is modifier:
  v: false

id:
  v: Consent.except.modifierExtension
path:
  v: Consent.except.modifierExtension
short:
  v: Extensions that cannot be ignored
definition:
  v: May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
alias:
  v: extensions
alias:
  v: user content
alias:
  v: modifiers
min:
  v: 0
max:
  v: *
base:
  path:
    v: BackboneElement.modifierExtension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
is modifier:
  v: true
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Consent.except.type
path:
  v: Consent.except.type
short:
  v: deny | permit
definition:
  v: Action to take - permit or deny - when the exception conditions are met.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Consent.except.type
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: code
    l: code
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: ConsentExceptType
  strength:
    v: required
  description:
    v: How an exception statement is applied, such as adding additional consent or removing consent
  value set: Reference
    l: 3.0
    l: .2
    reference:
      v: http://hl7.org/fhir/ValueSet/consent-except-type|3.0.2

id:
  v: Consent.except.period
path:
  v: Consent.except.period
short:
  v: Timeframe for this exception
definition:
  v: The timeframe in this exception is valid.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Consent.except.period
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Period
    l: Period
is summary:
  v: true

id:
  v: Consent.except.actor
path:
  v: Consent.except.actor
short:
  v: Who|what controlled by this exception (or group, by role)
definition:
  v: Who or what is controlled by this Exception. Use group to identify a set of actors by some property they share (e.g. 'admitting officers').
min:
  v: 0
max:
  v: *
base:
  path:
    v: Consent.except.actor
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: BackboneElement
    l: BackboneElement
meaning when missing:
  v: There is no specific actor associated with the exception
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() | (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is summary:
  v: true

id:
  v: Consent.except.actor.id
path:
  v: Consent.except.actor.id
representation:
  v: xmlAttr
short:
  v: xml:id (or equivalent in JSON)
definition:
  v: unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Consent.except.actor.extension
path:
  v: Consent.except.actor.extension
short:
  v: Additional Content defined by implementations
definition:
  v: May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Consent.except.actor.modifierExtension
path:
  v: Consent.except.actor.modifierExtension
short:
  v: Extensions that cannot be ignored
definition:
  v: May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
alias:
  v: extensions
alias:
  v: user content
alias:
  v: modifiers
min:
  v: 0
max:
  v: *
base:
  path:
    v: BackboneElement.modifierExtension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
is modifier:
  v: true
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Consent.except.actor.role
path:
  v: Consent.except.actor.role
short:
  v: How the actor is involved
definition:
  v: How the individual is involved in the resources content that is described in the exception.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Consent.except.actor.role
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: ConsentActorRole
  strength:
    v: extensible
  description:
    v: How an actor is involved in the consent considerations
  value set: Reference
    l: 1.8
    l: .0
    reference:
      v: http://hl7.org/fhir/ValueSet/security-role-type|1.8.0

id:
  v: Consent.except.actor.reference
path:
  v: Consent.except.actor.reference
short:
  v: Resource for the actor (or group, by role)
definition:
  v: The resource that identifies the actor. To identify a actors by type, use group to identify a set of actors by some property they share (e.g. 'admitting officers').
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Consent.except.actor.reference
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Device
    l: Device
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Group
    l: Group
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/CareTeam
    l: CareTeam
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Organization
    l: Organization
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Patient
    l: Patient
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Practitioner
    l: Practitioner
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/RelatedPerson
    l: RelatedPerson

id:
  v: Consent.except.action
path:
  v: Consent.except.action
short:
  v: Actions controlled by this exception
definition:
  v: Actions controlled by this Exception.
comment:
  v: 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'.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Consent.except.action
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
meaning when missing:
  v: all actions
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: ConsentAction
  strength:
    v: example
  description:
    v: Detailed codes for the consent action.
  value set: Reference
    l: 3.0
    l: .2
    reference:
      v: http://hl7.org/fhir/ValueSet/consent-action|3.0.2

id:
  v: Consent.except.securityLabel
path:
  v: Consent.except.securityLabel
short:
  v: Security Labels that define affected resources
definition:
  v: A set of security labels that define which resources are controlled by this exception. If more than one label is specified, all resources must have all the specified labels.
comment:
  v: If the consent specifies a security label of "R" then it applies to all resources that are labeled "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?).
min:
  v: 0
max:
  v: *
base:
  path:
    v: Consent.except.securityLabel
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Coding
    l: Coding
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: SecurityLabels
  strength:
    v: extensible
  description:
    v: Security Labels from the Healthcare Privacy and Security Classification System.
  value set: Reference
    l: 3.0
    l: .2
    reference:
      v: http://hl7.org/fhir/ValueSet/security-labels|3.0.2

id:
  v: Consent.except.purpose
path:
  v: Consent.except.purpose
short:
  v: Context of activities covered by this exception
definition:
  v: The context of the activities a user is taking - why the user is accessing the data - that are controlled by this exception.
comment:
  v: 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?).
min:
  v: 0
max:
  v: *
base:
  path:
    v: Consent.except.purpose
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Coding
    l: Coding
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: PurposeOfUse
  strength:
    v: extensible
  description:
    v: What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels
  value set: Reference
    l: 2014
    l: -03
    l: -26
    reference:
      v: http://hl7.org/fhir/ValueSet/v3-PurposeOfUse|2014-03-26

id:
  v: Consent.except.class
path:
  v: Consent.except.class
short:
  v: e.g. Resource Type, Profile, or CDA etc
definition:
  v: The class of information covered by this exception. The type can be a FHIR resource type, a profile on a type, or a CDA document, or some other type that indicates what sort of information the consent relates to.
comment:
  v: 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.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Consent.except.class
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Coding
    l: Coding
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: ConsentContentClass
  strength:
    v: extensible
  description:
    v: The class (type) of information a consent rule covers
  value set: Reference
    l: 3.0
    l: .2
    reference:
      v: http://hl7.org/fhir/ValueSet/consent-content-class|3.0.2

id:
  v: Consent.except.code
path:
  v: Consent.except.code
short:
  v: e.g. LOINC or SNOMED CT code, etc in the content
definition:
  v: If this code is found in an instance, then the exception applies.
comment:
  v: Typical use of this is a Document code with class = CDA.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Consent.except.code
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Coding
    l: Coding
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: ConsentContentCode
  strength:
    v: example
  description:
    v: If this code is found in an instance, then the exception applies
  value set: Reference
    l: 3.0
    l: .2
    reference:
      v: http://hl7.org/fhir/ValueSet/consent-content-code|3.0.2

id:
  v: Consent.except.code.id
path:
  v: Consent.except.code.id
representation:
  v: xmlAttr
short:
  v: xml:id (or equivalent in JSON)
definition:
  v: unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Consent.except.code.extension
path:
  v: Consent.except.code.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  ordered:
    v: false
  rules:
    v: open
short:
  v: Extension
definition:
  v: An Extension
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension

id:
  v: Consent.except.code.extension:code
path:
  v: Consent.except.code.extension
slice name:
  v: code
short:
  v: R5: e.g. LOINC or SNOMED CT code, etc. in the content additional types
definition:
  v: R5: `Consent.provision.code` additional types (CodeableConcept) additional types from child elements (text)
comment:
  v: Element `Consent.provision.code` is mapped to FHIR STU3 element `Consent.except.code` as `SourceIsBroaderThanTarget`. The mappings for `Consent.provision.code` do not cover the following types: CodeableConcept. The mappings for `Consent.provision.code` do not cover the following types based on type expansion: text.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.provision.code|0.1.0
    l: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.provision.code

id:
  v: Consent.except.code.system
path:
  v: Consent.except.code.system
short:
  v: Identity of the terminology system
definition:
  v: The identification of the code system that defines the meaning of the symbol in the code.
comment:
  v: The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.
requirements:
  v: Need to be unambiguous about the source of the definition of the symbol.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Coding.system
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: uri
    l: uri
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: C*E.3
mapping:
  identity:
    v: rim
  map:
    v: ./codeSystem
mapping:
  identity:
    v: orim
  map:
    v: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

id:
  v: Consent.except.code.version
path:
  v: Consent.except.code.version
short:
  v: Version of the system - if relevant
definition:
  v: The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
comment:
  v: Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Coding.version
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: C*E.7
mapping:
  identity:
    v: rim
  map:
    v: ./codeSystemVersion
mapping:
  identity:
    v: orim
  map:
    v: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

id:
  v: Consent.except.code.code
path:
  v: Consent.except.code.code
short:
  v: Symbol in syntax defined by the system
definition:
  v: A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
requirements:
  v: Need to refer to a particular code in the system.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Coding.code
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: C*E.1
mapping:
  identity:
    v: rim
  map:
    v: ./code
mapping:
  identity:
    v: orim
  map:
    v: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

id:
  v: Consent.except.code.display
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable
    l: elementdefinition-translatable
  value: Boolean
    v: true
path:
  v: Consent.except.code.display
short:
  v: Representation defined by the system
definition:
  v: A representation of the meaning of the code in the system, following the rules of the system.
requirements:
  v: Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Coding.display
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: C*E.2 - but note this is not well followed
mapping:
  identity:
    v: rim
  map:
    v: CV.displayName
mapping:
  identity:
    v: orim
  map:
    v: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

id:
  v: Consent.except.code.userSelected
path:
  v: Consent.except.code.userSelected
short:
  v: If this coding was chosen directly by the user
definition:
  v: Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).
comment:
  v: Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
requirements:
  v: This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Coding.userSelected
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
    l: boolean
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: Sometimes implied by being first
mapping:
  identity:
    v: rim
  map:
    v: CD.codingRationale
mapping:
  identity:
    v: orim
  map:
    v: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

id:
  v: Consent.except.dataPeriod
path:
  v: Consent.except.dataPeriod
short:
  v: Timeframe for data controlled by this exception
definition:
  v: Clinical or Operational Relevant period of time that bounds the data controlled by this exception.
comment:
  v: 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.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Consent.except.dataPeriod
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Period
    l: Period
is summary:
  v: true

id:
  v: Consent.except.data
path:
  v: Consent.except.data
short:
  v: Data controlled by this exception
definition:
  v: The resources controlled by this exception, if specific resources are referenced.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Consent.except.data
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: BackboneElement
    l: BackboneElement
meaning when missing:
  v: all data
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() | (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: Role

id:
  v: Consent.except.data.id
path:
  v: Consent.except.data.id
representation:
  v: xmlAttr
short:
  v: xml:id (or equivalent in JSON)
definition:
  v: unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Consent.except.data.extension
path:
  v: Consent.except.data.extension
short:
  v: Additional Content defined by implementations
definition:
  v: May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Consent.except.data.modifierExtension
path:
  v: Consent.except.data.modifierExtension
short:
  v: Extensions that cannot be ignored
definition:
  v: May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
alias:
  v: extensions
alias:
  v: user content
alias:
  v: modifiers
min:
  v: 0
max:
  v: *
base:
  path:
    v: BackboneElement.modifierExtension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
is modifier:
  v: true
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Consent.except.data.meaning
path:
  v: Consent.except.data.meaning
short:
  v: instance | related | dependents | authoredby
definition:
  v: How the resource reference is interpreted when testing consent restrictions.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Consent.except.data.meaning
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: code
    l: code
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: ConsentDataMeaning
  strength:
    v: required
  description:
    v: How a resource reference is interpreted when testing consent restrictions
  value set: Reference
    l: 3.0
    l: .2
    reference:
      v: http://hl7.org/fhir/ValueSet/consent-data-meaning|3.0.2

id:
  v: Consent.except.data.reference
path:
  v: Consent.except.data.reference
short:
  v: The actual data reference
definition:
  v: A reference to a specific resource that defines which resources are covered by this consent.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Consent.except.data.reference
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Resource
    l: Resource
is summary:
  v: true

element:
  id:
    v: Consent
  path:
    v: Consent
element:
  id:
    v: Consent.extension
  path:
    v: Consent.extension
  slicing:
    discriminator:
      type:
        v: value
      path:
        v: url
    ordered:
      v: false
    rules:
      v: open
  min:
    v: 0
  max:
    v: *
element:
  id:
    v: Consent.extension:period
  path:
    v: Consent.extension
  slice name:
    v: period
  short:
    v: R5: Effective period for this Consent (new)
  definition:
    v: R5: `Consent.period` (new:Period)
  comment:
    v: Element `Consent.period` has a context of Consent based on following the parent source element upwards and mapping to `Consent`. Element `Consent.period` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).
  min:
    v: 0
  max:
    v: 1
  base:
    path:
      v: DomainResource.extension
    min:
      v: 0
    max:
      v: *
  type:
    code:
      v: Extension
      l: Extension
    profile:
      v: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.period|0.1.0
      l: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.period
element:
  id:
    v: Consent.extension:grantor
  path:
    v: Consent.extension
  slice name:
    v: grantor
  short:
    v: R5: Who is granting rights according to the policy and rules (new)
  definition:
    v: R5: `Consent.grantor` (new:Reference(CareTeam,HealthcareService,Organization,Patient,Practitioner,RelatedPerson,PractitionerRole))
  comment:
    v: Element `Consent.grantor` has a context of Consent based on following the parent source element upwards and mapping to `Consent`. Element `Consent.grantor` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).
  min:
    v: 0
  max:
    v: *
  base:
    path:
      v: DomainResource.extension
    min:
      v: 0
    max:
      v: *
  type:
    code:
      v: Extension
      l: Extension
    profile:
      v: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor|0.1.0
      l: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor
element:
  id:
    v: Consent.extension:manager
  path:
    v: Consent.extension
  slice name:
    v: manager
  short:
    v: R5: Consent workflow management (new)
  definition:
    v: R5: `Consent.manager` (new:Reference(HealthcareService,Organization,Patient,Practitioner))
  comment:
    v: Element `Consent.manager` has a context of Consent based on following the parent source element upwards and mapping to `Consent`. Element `Consent.manager` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).
  min:
    v: 0
  max:
    v: *
  base:
    path:
      v: DomainResource.extension
    min:
      v: 0
    max:
      v: *
  type:
    code:
      v: Extension
      l: Extension
    profile:
      v: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.manager|0.1.0
      l: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.manager
element:
  id:
    v: Consent.extension:controller
  path:
    v: Consent.extension
  slice name:
    v: controller
  short:
    v: R5: Consent Enforcer (new)
  definition:
    v: R5: `Consent.controller` (new:Reference(HealthcareService,Organization,Patient,Practitioner))
  comment:
    v: Element `Consent.controller` has a context of Consent based on following the parent source element upwards and mapping to `Consent`. Element `Consent.controller` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).
  min:
    v: 0
  max:
    v: *
  base:
    path:
      v: DomainResource.extension
    min:
      v: 0
    max:
      v: *
  type:
    code:
      v: Extension
      l: Extension
    profile:
      v: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.controller|0.1.0
      l: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.controller
element:
  id:
    v: Consent.extension:policyText
  path:
    v: Consent.extension
  slice name:
    v: policyText
  short:
    v: R5: Human Readable Policy (new)
  definition:
    v: R5: `Consent.policyText` (new:Reference(DocumentReference))
  comment:
    v: Element `Consent.policyText` has a context of Consent based on following the parent source element upwards and mapping to `Consent`. Element `Consent.policyText` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).
  min:
    v: 0
  max:
    v: *
  base:
    path:
      v: DomainResource.extension
    min:
      v: 0
    max:
      v: *
  type:
    code:
      v: Extension
      l: Extension
    profile:
      v: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.policyText|0.1.0
      l: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.policyText
element:
  id:
    v: Consent.extension:verification
  path:
    v: Consent.extension
  slice name:
    v: verification
  short:
    v: R5: Consent Verified by patient or family (new)
  definition:
    v: R5: `Consent.verification` (new:BackboneElement)
  comment:
    v: Element `Consent.verification` has a context of Consent based on following the parent source element upwards and mapping to `Consent`. Element `Consent.verification` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).
  min:
    v: 0
  max:
    v: *
  base:
    path:
      v: DomainResource.extension
    min:
      v: 0
    max:
      v: *

code:
  v: Extension
  l: Extension
profile:
  v: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.verification|0.1.0
  l: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.verification

id:
  v: Consent.extension:reference
path:
  v: Consent.extension
slice name:
  v: reference
short:
  v: R5: Resource for the actor (or group, by role)
definition:
  v: R5: `Consent.provision.actor.reference`
comment:
  v: Element `Consent.provision.actor.reference` is mapped to FHIR STU3 element `Consent.actor.reference` as `SourceIsBroaderThanTarget`. Element `Consent.provision.actor.reference` is mapped to FHIR STU3 element `Consent.except.actor.reference` as `SourceIsBroaderThanTarget`. The standard extension `alternate-reference` has been mapped as the representation of FHIR R5 element `Consent.provision.actor.reference` with unmapped reference targets: CareTeam, Device, Group, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/StructureDefinition/alternate-reference
    l: alternate-reference

id:
  v: Consent.extension:reference
path:
  v: Consent.extension
slice name:
  v: reference
short:
  v: R5: The actual data reference additional types
definition:
  v: R5: `Consent.provision.data.reference` additional types from child elements (display, identifier, reference, type)
comment:
  v: Element `Consent.provision.data.reference` is mapped to FHIR STU3 element `Consent.data.reference` as `SourceIsBroaderThanTarget`. Element `Consent.provision.data.reference` is mapped to FHIR STU3 element `Consent.except.data.reference` as `SourceIsBroaderThanTarget`. The mappings for `Consent.provision.data.reference` do not cover the following types based on type expansion: display, identifier, reference, type. The standard extension `alternate-reference` has been mapped as the representation of FHIR R5 element `Consent.provision.data.reference` with unmapped reference targets: Resource.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/StructureDefinition/alternate-reference
    l: alternate-reference

id:
  v: Consent.modifierExtension
path:
  v: Consent.modifierExtension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  ordered:
    v: false
  rules:
    v: open
min:
  v: 0
max:
  v: *

id:
  v: Consent.modifierExtension:decision
path:
  v: Consent.modifierExtension
slice name:
  v: decision
short:
  v: R5: deny | permit (new)
definition:
  v: R5: `Consent.decision` (new:code)
comment:
  v: Element `Consent.decision` has a context of Consent based on following the parent source element upwards and mapping to `Consent`. Element `Consent.decision` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.decision|0.1.0
    l: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.decision

id:
  v: Consent.status.extension
path:
  v: Consent.status.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  ordered:
    v: false
  rules:
    v: open
min:
  v: 0
max:
  v: *

id:
  v: Consent.status.extension:status
path:
  v: Consent.status.extension
slice name:
  v: status
short:
  v: R5: draft | active | inactive | not-done | entered-in-error | unknown
definition:
  v: R5: `Consent.status`
comment:
  v: Element `Consent.status` is mapped to FHIR STU3 element `Consent.status` as `SourceIsBroaderThanTarget`. The target context `Consent.status` is a modifier element, so this extension does not need to be defined as a modifier. This element is labeled as a modifier because the status contains the codes rejected and entered-in-error that mark the Consent as not currently valid.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.status|0.1.0
    l: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.status

id:
  v: Consent.patient.extension
path:
  v: Consent.patient.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  ordered:
    v: false
  rules:
    v: open
min:
  v: 0
max:
  v: *

id:
  v: Consent.patient.extension:subject
path:
  v: Consent.patient.extension
slice name:
  v: subject
short:
  v: R5: subject
definition:
  v: R5: `Consent.subject`
comment:
  v: Element `Consent.subject` is mapped to FHIR STU3 element `Consent.patient` as `SourceIsBroaderThanTarget`. The standard extension `alternate-reference` has been mapped as the representation of FHIR R5 element `Consent.subject` with unmapped reference targets: Group, Patient, Practitioner.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/StructureDefinition/alternate-reference
    l: alternate-reference

id:
  v: Consent.consentingParty.extension
path:
  v: Consent.consentingParty.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  ordered:
    v: false
  rules:
    v: open
min:
  v: 0
max:
  v: *

id:
  v: Consent.consentingParty.extension:grantee
path:
  v: Consent.consentingParty.extension
slice name:
  v: grantee
short:
  v: R5: Who is agreeing to the policy and rules
definition:
  v: R5: `Consent.grantee`
comment:
  v: Element `Consent.grantee` is mapped to FHIR STU3 element `Consent.consentingParty` as `SourceIsBroaderThanTarget`. The standard extension `alternate-reference` has been mapped as the representation of FHIR R5 element `Consent.grantee` with unmapped reference targets: CareTeam, HealthcareService, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson. In a fully computable consent, both grantee and grantor will be listed as actors within the consent. The Grantee and Grantor elements are for ease of search only.
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/StructureDefinition/alternate-reference
    l: alternate-reference

id:
  v: Consent.sourceReference.extension
path:
  v: Consent.sourceReference.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  ordered:
    v: false
  rules:
    v: open
min:
  v: 0
max:
  v: *

id:
  v: Consent.sourceReference.extension:alternateReference
path:
  v: Consent.sourceReference.extension
slice name:
  v: alternateReference
short:
  v: R5: sourceReference
definition:
  v: R5: `Consent.sourceReference`
comment:
  v: Element `Consent.sourceReference` is mapped to FHIR STU3 element `Consent.source[x]` as `SourceIsBroaderThanTarget`. The standard extension `alternate-reference` has been mapped as the representation of FHIR R5 element `Consent.sourceReference` with unmapped reference targets: Consent, Contract, DocumentReference, QuestionnaireResponse. Source element `Consent.sourceReference` has unmapped reference types. While the target element `Consent.source[x]` is a choice type and does not allow extensions, the `alternate-reference` extension can be applied to Reference values within it. 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.
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/StructureDefinition/alternate-reference
    l: alternate-reference

id:
  v: Consent.policyRule.extension
path:
  v: Consent.policyRule.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  ordered:
    v: false
  rules:
    v: open
min:
  v: 0
max:
  v: *

id:
  v: Consent.policyRule.extension:regulatoryBasis
path:
  v: Consent.policyRule.extension
slice name:
  v: regulatoryBasis
short:
  v: R5: Regulations establishing base Consent additional types
definition:
  v: R5: `Consent.regulatoryBasis` additional types (CodeableConcept) additional types from child elements (coding, text)
comment:
  v: Element `Consent.regulatoryBasis` is mapped to FHIR STU3 element `Consent.policyRule` as `SourceIsBroaderThanTarget`. The mappings for `Consent.regulatoryBasis` do not cover the following types: CodeableConcept. The mappings for `Consent.regulatoryBasis` do not cover the following types based on type expansion: coding, text.
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.regulatoryBasis|0.1.0
    l: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.regulatoryBasis

id:
  v: Consent.except.extension
path:
  v: Consent.except.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  ordered:
    v: false
  rules:
    v: open
min:
  v: 0
max:
  v: *

id:
  v: Consent.except.extension:expression
path:
  v: Consent.except.extension
slice name:
  v: expression
short:
  v: R5: A computable expression of the consent (new)
definition:
  v: R5: `Consent.provision.expression` (new:Expression)
comment:
  v: Element `Consent.provision.expression` has a context of Consent.except based on following the parent source element upwards and mapping to `Consent`. Element `Consent.provision.expression` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). Constraining the expression type for a specific implementation via profile is recommended
min:
  v: 0
max:
  v: 1
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.provision.expression|0.1.0
    l: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.provision.expression

id:
  v: Consent.except.extension:provision
path:
  v: Consent.except.extension
slice name:
  v: provision
short:
  v: R5: Nested Exception Provisions (new)
definition:
  v: R5: `Consent.provision.provision` (new:Consent.provision)
comment:
  v: Element `Consent.provision.provision` has a context of Consent.except based on following the parent source element upwards and mapping to `Consent`. Element `Consent.provision.provision` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.provision|0.1.0
    l: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.provision

id:
  v: Consent.except.code.extension
path:
  v: Consent.except.code.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  ordered:
    v: false
  rules:
    v: open
min:
  v: 0
max:
  v: *

id:
  v: Consent.except.code.extension:code
path:
  v: Consent.except.code.extension
slice name:
  v: code
short:
  v: R5: e.g. LOINC or SNOMED CT code, etc. in the content additional types
definition:
  v: R5: `Consent.provision.code` additional types (CodeableConcept) additional types from child elements (text)
comment:
  v: Element `Consent.provision.code` is mapped to FHIR STU3 element `Consent.except.code` as `SourceIsBroaderThanTarget`. The mappings for `Consent.provision.code` do not cover the following types: CodeableConcept. The mappings for `Consent.provision.code` do not cover the following types based on type expansion: text.
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.provision.code|0.1.0
    l: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.provision.code