Healthy Route Implementation Guide
0.1.0 - ci-build

Healthy Route Implementation Guide, published by Savannah Informatics. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/savannahghi/healthy-route-ig/ and changes regularly. See the Directory of published versions

Resource Profile: HRConsent - Detailed Descriptions

Draft as of 2026-09-04

Definitions for the hr-consent resource profile.

Guidance on how to interpret the contents of this table can be foundhere

0. Consent
Definition

A record of a healthcare consumer’s choices or choices made on their behalf by a third party, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.

ShortA healthcare consumer's or third party's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
Comments

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 consent for research participation and data sharing.

Control0..*
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. Consent.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. Consent.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

ShortContained, inline Resources
Comments

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. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.

Control0..*
This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
TypeResource
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
6. Consent.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortExtensionAdditional content defined by implementations
Comments

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.

Control10..*
TypeExtension
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Consent.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 8. Consent.extension:tenant
    Slice Nametenant
    Definition

    Identifies the site tenant that owns the resource.

    ShortOwning site tenant
    Control1..1
    TypeExtension(Tenant) (Extension Type: Identifier)
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    10. Consent.modifierExtension
    Definition

    May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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.

    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

    ShortExtensions that cannot be ignored
    Comments

    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.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
    Must Supportfalse
    Summarytrue
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    12. Consent.status
    Definition

    Indicates the current state of this Consent resource.

    Shortdraft | active | inactive | not-done | entered-in-error | unknown
    Comments

    draft is used between the point at which the participant signs and the point at which the record has been checked against the paper. A draft consent does not authorise any activity.


    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.

    Control1..1
    BindingThe codes SHALL be taken from ConsentStatehttp://hl7.org/fhir/ValueSet/consent-state-codes|5.0.0
    (required to http://hl7.org/fhir/ValueSet/consent-state-codes|5.0.0)

    Indicates the state of the consent.

    Typecode
    Is Modifiertrue because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    Requirements

    Withdrawal is recorded by setting this to inactive. The resource is not deleted and its content is not altered, so the fact that consent was once held, and the date it ceased, remain available to an auditor.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    14. Consent.category
    Definition

    A classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements.

    ShortClassification of the consent statement - for indexing/retrieval
    Control10..*
    BindingFor example codes, see ConsentCategoryCodeshttp://hl7.org/fhir/ValueSet/consent-category|5.0.0
    (example to http://hl7.org/fhir/ValueSet/consent-category|5.0.0)

    A classification of the type of consents found in a consent statement.

    TypeCodeableConcept
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    SlicingThis element introduces a set of slices on Consent.category. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ coding.system
    • 16. Consent.category:permission
      Slice Namepermission
      Definition

      A classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements.

      ShortWhich permission this resource recordsClassification of the consent statement - for indexing/retrieval
      Comments

      One permission per resource. A participant who is asked three questions on one form is represented by three resources sharing a date and a source reference.

      Control10..1*
      BindingThe codes SHALL be taken from For example codes, see Consent Permission Value Sethttp://hl7.org/fhir/ValueSet/consent-category|5.0.0
      (required to https://fhir.savannahghi.org/ig/healthy-route/ValueSet/hr-consent-permission-vs)
      TypeCodeableConcept
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      18. Consent.category:permission.coding
      Definition

      A reference to a code defined by a terminology system.

      ShortCode defined by a terminology system
      Comments

      Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

      Control10..1*
      TypeCoding
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Requirements

      Allows for alternative encodings within a code system, and translations to other code systems.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      20. Consent.category:permission.coding.system
      Definition

      The identification of the code system that defines the meaning of the symbol in the code.

      ShortIdentity of the terminology system
      Comments

      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 be an absolute reference to some definition that establishes the system clearly and unambiguously.

      Control10..1
      Typeuri
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summarytrue
      Requirements

      Need to be unambiguous about the source of the definition of the symbol.

      Pattern Valuehttps://fhir.savannahghi.org/ig/healthy-route/CodeSystem/hr-consent-permission
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      22. Consent.subject
      Definition

      The patient/healthcare practitioner or group of persons to whom this consent applies.

      ShortWho the consent applies to
      Comments

      Constrained to Patient. Consent is never taken from a practitioner or a group in this study, and the base resource permits both.

      Control10..1
      TypeReference(Healthy Route Patient, Patient, Practitioner, Group)
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      24. Consent.date
      Definition

      Date the consent instance was agreed to.

      ShortDate the participant signedFully executed date of the consent
      Comments

      The date on the paper form, which may precede the date the record was created.

      Control10..1
      Typedate
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summarytrue
      Requirements

      Compared against the date of the earliest study activity. An encounter, specimen or image dated before this is a protocol deviation, and the comparison is only possible if the signature date rather than the data entry date is recorded here.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      26. Consent.period
      Definition

      Effective period for this Consent Resource and all provisions unless specified in that provision.

      ShortPeriod over which the permission appliesEffective period for this Consent
      Comments

      Distinct from the retention period stated in the information sheet. Present where the permission itself is time limited.

      Control0..1
      TypePeriod
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Alternate Namesperiod
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      28. Consent.grantor
      Definition

      The entity responsible for granting the rights listed in a Consent Directive.

      ShortWho is granting rights according to the policy and rules
      Comments

      Ordinarily the participant. RelatedPerson is admitted because both protocols provide for consent given by a legally authorised representative, and an earlier version of this profile constrained the element to Patient while its own comment said the resource must not preclude that. Where a representative consents, subject remains the participant and grantor is the representative, which is the distinction the two elements exist to carry.

      Control10..1*
      TypeReference(Healthy Route Patient, RelatedPerson, CareTeam, HealthcareService, Organization, Patient, Practitioner, RelatedPerson, PractitionerRole)
      Is Modifierfalse
      Must Supporttrue
      Must Support TypesNo must-support rules about the choice of types/profiles
      Summarytrue
      Alternate Namesgrantor
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      30. Consent.grantee
      Definition

      The entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations and enforcement of prohibitions.

      ShortParty the permission is granted toWho is agreeing to the policy and rules
      Comments

      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.

      Control10..*
      TypeReference(Healthy Route Organization, CareTeam, HealthcareService, Organization, Patient, Practitioner, RelatedPerson, PractitionerRole)
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Requirements

      The information sheet names the parties who will hold the data. Where a permission extends beyond the site to a party receiving the exported data, both appear here, and a permission naming only the site does not authorise transfer.

      Alternate Namesgrantee
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      32. Consent.controller
      Definition

      The actor that controls/enforces the access according to the consent.

      ShortData controllerConsent Enforcer
      Control0..*
      TypeReference(Healthy Route Organization, HealthcareService, Organization, Patient, Practitioner)
      Is Modifierfalse
      Must Supporttrue
      Summaryfalse
      Alternate Namescontroller
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      34. Consent.sourceReference
      Definition

      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.

      ShortThe photographed signed pageSource from which this consent is taken
      Comments

      Optional, and expected to be absent at most sites. The protocol requires the investigator to retain the signed form and states that no records may be transferred to another location or party without written notification to the sponsor; it requires the medical record to carry a statement that consent was obtained and the date, which this resource satisfies without an image. Present only where a site has chosen to hold a photograph of the page within its own tenant and its ethics committee has approved that, which is a decision beyond the protocol rather than one it mandates.


      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.

      Control0..1*
      TypeReference(Healthy Route Consent Evidence, Consent, DocumentReference, Contract, QuestionnaireResponse)
      Is Modifierfalse
      Must Supporttrue
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      36. Consent.regulatoryBasis
      Definition

      A set of codes that indicate the regulatory basis (if any) that this consent supports.

      ShortRegulatory framework the consent was taken underRegulations establishing base Consent
      Comments

      The national research regulation that governs the site, which differs between participating countries. Country variation is carried on instances rather than by separate profiles.

      Control0..*
      BindingFor example codes, see ConsentPolicyRuleCodeshttp://hl7.org/fhir/ValueSet/consent-policy|5.0.0
      (example to http://hl7.org/fhir/ValueSet/consent-policy|5.0.0)

      Regulatory policy examples

      TypeCodeableConcept
      Is Modifierfalse
      Must Supporttrue
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      38. Consent.policyBasis
      Definition

      A Reference or URL used to uniquely identify the policy the organization will enforce for this Consent. This Reference or URL should be specific to the version of the policy and should be dereferencable to a computable policy of some form.

      ShortComputable version of the backing policy
      Control10..1
      TypeBackboneElement
      Is Modifierfalse
      Must Supporttrue
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      40. Consent.policyBasis.modifierExtension
      Definition

      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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

      Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

      ShortExtensions that cannot be ignored even if unrecognized
      Comments

      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.

      Control0..*
      TypeExtension
      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
      Summarytrue
      Requirements

      Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

      Alternate Namesextensions, user content, modifiers
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      42. Consent.policyBasis.url
      Definition

      A URL that links to a computable version of the policy the organization will enforce for this Consent.

      ShortVersioned identifier of the approved information sheetURL to a computable backing policy
      Comments

      Identifies a version, not a document to display. The document itself is referenced from policyText.

      Control10..1
      Typeurl
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summaryfalse
      Requirements

      Ethics committees approve a specific version of the participant information sheet and consent form. Establishing which version a participant was shown is the first question asked when a form is amended mid-study, and it cannot be answered from the signature alone.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      44. Consent.policyText
      Definition

      A Reference to the human readable policy explaining the basis for the Consent.

      ShortThe approved blank information sheet and consent formHuman Readable Policy
      Comments

      The unsigned template as approved, identical for every participant given that version. Not to be confused with sourceReference, which is the individual signed page and is identifying.

      Control0..*
      TypeReference(Healthy Route Document, DocumentReference)
      Is Modifierfalse
      Must Supporttrue
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      46. Consent.verification
      Definition

      Whether a treatment instruction (e.g. artificial respiration: yes or no) was verified with the patient, his/her family or another authorized person.

      ShortConsent Verified by patient or family
      Control10..1*
      TypeBackboneElement
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      48. Consent.verification.modifierExtension
      Definition

      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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

      Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

      ShortExtensions that cannot be ignored even if unrecognized
      Comments

      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.

      Control0..*
      TypeExtension
      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
      Summarytrue
      Requirements

      Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

      Alternate Namesextensions, user content, modifiers
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      50. Consent.verification.verified
      Definition

      Has the instruction been verified.

      ShortHas been verified
      Control1..1
      Typeboolean
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      52. Consent.verification.verifiedBy
      Definition

      The person who conducted the verification/validation of the Grantor decision.

      ShortPerson who took consentPerson conducting verification
      Comments

      The individual, not the organisation and not the role they held. The base resource admits all three; an organisation cannot be delegated to take consent, and recording the role rather than the person would leave the identity of the signatory on the paper form unmatched in the record. Where the delegation itself needs to be established, a PractitionerRole referring to the same practitioner carries it.

      Control10..1
      TypeReference(Healthy Route Practitioner, Organization, Practitioner, PractitionerRole)
      Is Modifierfalse
      Must Supporttrue
      Summaryfalse
      Requirements

      Good clinical practice requires that consent be taken by a person authorised to do so on the delegation log, and the protocol requires that person to sign the form. Recording who took it is what allows that authorisation to be checked after the fact.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      54. Consent.verification.verificationDate
      Definition

      Date(s) verification was collected.

      ShortWhen consent verified
      Comments

      Allows for history of verification/validation.

      Control10..1*
      TypedateTime
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      56. Consent.decision
      Definition

      Action to take - permit or deny - as default.

      Shortpermit or denydeny | permit
      Comments

      A refusal is recorded as an active consent with a decision of deny, not as an absent resource. The distinction between a participant who declined and a participant who was never asked is material at audit.

      Control10..1
      BindingThe codes SHALL be taken from ConsentProvisionTypehttp://hl7.org/fhir/ValueSet/consent-provision-type|5.0.0
      (required to http://hl7.org/fhir/ValueSet/consent-provision-type|5.0.0)

      Sets the base decision for Consent to be either permit or deny, with provisions assumed to be a negation of the previous level.

      Typecode
      Is Modifiertrue because Sets context for the values in .provision
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summarytrue
      Requirements

      Required, where the base resource makes it optional. A consent record whose decision is absent cannot be acted on, and its absence is indistinguishable from a refusal that was never recorded.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

      Guidance on how to interpret the contents of this table can be foundhere

      0. Consent
      2. Consent.extension
      Control1..?
      SlicingThis element introduces a set of slices on Consent.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 4. Consent.extension:tenant
        Slice Nametenant
        ShortOwning site tenant
        Control1..1
        TypeExtension(Tenant) (Extension Type: Identifier)
        Must Supporttrue
        6. Consent.status
        Comments

        draft is used between the point at which the participant signs and the point at which the record has been checked against the paper. A draft consent does not authorise any activity.

        Must Supporttrue
        Requirements

        Withdrawal is recorded by setting this to inactive. The resource is not deleted and its content is not altered, so the fact that consent was once held, and the date it ceased, remain available to an auditor.

        8. Consent.category
        Control1..?
        Must Supporttrue
        SlicingThis element introduces a set of slices on Consent.category. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ coding.system
        • 10. Consent.category:permission
          Slice Namepermission
          ShortWhich permission this resource records
          Comments

          One permission per resource. A participant who is asked three questions on one form is represented by three resources sharing a date and a source reference.

          Control1..1
          BindingThe codes SHALL be taken from Consent Permission Value Set
          (required to https://fhir.savannahghi.org/ig/healthy-route/ValueSet/hr-consent-permission-vs)
          Must Supporttrue
          12. Consent.category:permission.coding
          Control1..1
          Must Supporttrue
          14. Consent.category:permission.coding.system
          Control1..?
          Must Supporttrue
          Pattern Valuehttps://fhir.savannahghi.org/ig/healthy-route/CodeSystem/hr-consent-permission
          16. Consent.subject
          Comments

          Constrained to Patient. Consent is never taken from a practitioner or a group in this study, and the base resource permits both.

          Control1..?
          TypeReference(Healthy Route Patient)
          Must Supporttrue
          18. Consent.date
          ShortDate the participant signed
          Comments

          The date on the paper form, which may precede the date the record was created.

          Control1..?
          Must Supporttrue
          Requirements

          Compared against the date of the earliest study activity. An encounter, specimen or image dated before this is a protocol deviation, and the comparison is only possible if the signature date rather than the data entry date is recorded here.

          20. Consent.period
          ShortPeriod over which the permission applies
          Comments

          Distinct from the retention period stated in the information sheet. Present where the permission itself is time limited.

          Must Supporttrue
          22. Consent.grantor
          Comments

          Ordinarily the participant. RelatedPerson is admitted because both protocols provide for consent given by a legally authorised representative, and an earlier version of this profile constrained the element to Patient while its own comment said the resource must not preclude that. Where a representative consents, subject remains the participant and grantor is the representative, which is the distinction the two elements exist to carry.

          Control1..1
          TypeReference(Healthy Route Patient, RelatedPerson)
          Must Supporttrue
          Must Support TypesNo must-support rules about the choice of types/profiles
          24. Consent.grantee
          ShortParty the permission is granted to
          Control1..?
          TypeReference(Healthy Route Organization)
          Must Supporttrue
          Requirements

          The information sheet names the parties who will hold the data. Where a permission extends beyond the site to a party receiving the exported data, both appear here, and a permission naming only the site does not authorise transfer.

          26. Consent.controller
          ShortData controller
          TypeReference(Healthy Route Organization)
          Must Supporttrue
          28. Consent.sourceReference
          ShortThe photographed signed page
          Comments

          Optional, and expected to be absent at most sites. The protocol requires the investigator to retain the signed form and states that no records may be transferred to another location or party without written notification to the sponsor; it requires the medical record to carry a statement that consent was obtained and the date, which this resource satisfies without an image. Present only where a site has chosen to hold a photograph of the page within its own tenant and its ethics committee has approved that, which is a decision beyond the protocol rather than one it mandates.

          Control0..1
          TypeReference(Healthy Route Consent Evidence)
          Must Supporttrue
          30. Consent.regulatoryBasis
          ShortRegulatory framework the consent was taken under
          Comments

          The national research regulation that governs the site, which differs between participating countries. Country variation is carried on instances rather than by separate profiles.

          Must Supporttrue
          32. Consent.policyBasis
          Control1..?
          Must Supporttrue
          34. Consent.policyBasis.url
          ShortVersioned identifier of the approved information sheet
          Comments

          Identifies a version, not a document to display. The document itself is referenced from policyText.

          Control1..?
          Must Supporttrue
          Requirements

          Ethics committees approve a specific version of the participant information sheet and consent form. Establishing which version a participant was shown is the first question asked when a form is amended mid-study, and it cannot be answered from the signature alone.

          36. Consent.policyText
          ShortThe approved blank information sheet and consent form
          Comments

          The unsigned template as approved, identical for every participant given that version. Not to be confused with sourceReference, which is the individual signed page and is identifying.

          TypeReference(Healthy Route Document)
          Must Supporttrue
          38. Consent.verification
          Control1..1
          Must Supporttrue
          40. Consent.verification.verified
          Must Supporttrue
          42. Consent.verification.verifiedBy
          ShortPerson who took consent
          Comments

          The individual, not the organisation and not the role they held. The base resource admits all three; an organisation cannot be delegated to take consent, and recording the role rather than the person would leave the identity of the signatory on the paper form unmatched in the record. Where the delegation itself needs to be established, a PractitionerRole referring to the same practitioner carries it.

          Control1..?
          TypeReference(Healthy Route Practitioner)
          Must Supporttrue
          Requirements

          Good clinical practice requires that consent be taken by a person authorised to do so on the delegation log, and the protocol requires that person to sign the form. Recording who took it is what allows that authorisation to be checked after the fact.

          44. Consent.verification.verificationDate
          Control1..1
          Must Supporttrue
          46. Consent.decision
          Shortpermit or deny
          Comments

          A refusal is recorded as an active consent with a decision of deny, not as an absent resource. The distinction between a participant who declined and a participant who was never asked is material at audit.

          Control1..?
          Must Supporttrue
          Requirements

          Required, where the base resource makes it optional. A consent record whose decision is absent cannot be acted on, and its absence is indistinguishable from a refusal that was never recorded.

          Guidance on how to interpret the contents of this table can be foundhere

          0. Consent
          Definition

          A record of a healthcare consumer’s choices or choices made on their behalf by a third party, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.

          ShortA healthcare consumer's or third party's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
          Comments

          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 consent for research participation and data sharing.

          Control0..*
          Is Modifierfalse
          Must Supportfalse
          Summaryfalse
          Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
          dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
          dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
          dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
          dom-6: A resource should have narrative for robust management (text.`div`.exists())
          2. Consent.id
          Definition

          The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

          ShortLogical id of this artifact
          Comments

          Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

          Control0..1
          Typeid
          Is Modifierfalse
          Must Supportfalse
          Summarytrue
          4. Consent.meta
          Definition

          The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

          ShortMetadata about the resource
          Control0..1
          TypeMeta
          Is Modifierfalse
          Must Supportfalse
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          6. Consent.implicitRules
          Definition

          A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

          ShortA set of rules under which this content was created
          Comments

          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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

          Control0..1
          Typeuri
          Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supportfalse
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          8. Consent.language
          Definition

          The base language in which the resource is written.

          ShortLanguage of the resource content
          Comments

          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).

          Control0..1
          BindingThe codes SHALL be taken from AllLanguages
          (required to http://hl7.org/fhir/ValueSet/all-languages|5.0.0)

          IETF language tag for a human language

          Typecode
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supportfalse
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          10. Consent.text
          Definition

          A human-readable narrative that contains a summary of the resource and can 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.

          ShortText summary of the resource, for human interpretation
          Comments

          Contained resources do not have a 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 information is added later.

          Control0..1
          This element is affected by the following invariants: dom-6
          TypeNarrative
          Is Modifierfalse
          Must Supportfalse
          Summaryfalse
          Alternate Namesnarrative, html, xhtml, display
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          12. Consent.contained
          Definition

          These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

          ShortContained, inline Resources
          Comments

          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. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.

          Control0..*
          This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
          TypeResource
          Is Modifierfalse
          Must Supportfalse
          Summaryfalse
          Alternate Namesinline resources, anonymous resources, contained resources
          14. Consent.extension
          Definition

          An Extension

          ShortExtension
          Control1..*
          TypeExtension
          Is Modifierfalse
          Must Supportfalse
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          SlicingThis element introduces a set of slices on Consent.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 16. Consent.extension:tenant
            Slice Nametenant
            Definition

            Identifies the site tenant that owns the resource.

            ShortOwning site tenant
            Control1..1
            TypeExtension(Tenant) (Extension Type: Identifier)
            Is Modifierfalse
            Must Supporttrue
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            18. Consent.modifierExtension
            Definition

            May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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.

            Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

            ShortExtensions that cannot be ignored
            Comments

            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.

            Control0..*
            TypeExtension
            Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
            Must Supportfalse
            Summarytrue
            Requirements

            Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

            Alternate Namesextensions, user content
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            20. Consent.identifier
            Definition

            Unique identifier for this copy of the Consent Statement.

            ShortIdentifier for this record (external references)
            Comments

            This identifier 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.

            NoteThis is a business identifier, not a resource identifier (see discussion)
            Control0..*
            TypeIdentifier
            Is Modifierfalse
            Must Supportfalse
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            22. Consent.status
            Definition

            Indicates the current state of this Consent resource.

            Shortdraft | active | inactive | not-done | entered-in-error | unknown
            Comments

            draft is used between the point at which the participant signs and the point at which the record has been checked against the paper. A draft consent does not authorise any activity.

            Control1..1
            BindingThe codes SHALL be taken from ConsentState
            (required to http://hl7.org/fhir/ValueSet/consent-state-codes|5.0.0)

            Indicates the state of the consent.

            Typecode
            Is Modifiertrue because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supporttrue
            Summarytrue
            Requirements

            Withdrawal is recorded by setting this to inactive. The resource is not deleted and its content is not altered, so the fact that consent was once held, and the date it ceased, remain available to an auditor.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            24. Consent.category
            Definition

            A classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements.

            ShortClassification of the consent statement - for indexing/retrieval
            Control1..*
            BindingFor example codes, see ConsentCategoryCodes
            (example to http://hl7.org/fhir/ValueSet/consent-category|5.0.0)

            A classification of the type of consents found in a consent statement.

            TypeCodeableConcept
            Is Modifierfalse
            Must Supporttrue
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            SlicingThis element introduces a set of slices on Consent.category. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ coding.system
            • 26. Consent.category:permission
              Slice Namepermission
              Definition

              A classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements.

              ShortWhich permission this resource records
              Comments

              One permission per resource. A participant who is asked three questions on one form is represented by three resources sharing a date and a source reference.

              Control1..1
              BindingThe codes SHALL be taken from Consent Permission Value Set
              (required to https://fhir.savannahghi.org/ig/healthy-route/ValueSet/hr-consent-permission-vs)
              TypeCodeableConcept
              Is Modifierfalse
              Must Supporttrue
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              28. Consent.category:permission.id
              Definition

              Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

              ShortUnique id for inter-element referencing
              Control0..1
              This element is affected by the following invariants: ele-1
              Typeid
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              30. Consent.category:permission.extension
              Definition

              May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

              ShortAdditional content defined by implementations
              Comments

              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.

              Control0..*
              TypeExtension
              Is Modifierfalse
              Summaryfalse
              Alternate Namesextensions, user content
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              SlicingThis element introduces a set of slices on Consent.category.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 32. Consent.category:permission.coding
                Definition

                A reference to a code defined by a terminology system.

                ShortCode defined by a terminology system
                Comments

                Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                Control1..1
                TypeCoding
                Is Modifierfalse
                Must Supporttrue
                Summarytrue
                Requirements

                Allows for alternative encodings within a code system, and translations to other code systems.

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                34. Consent.category:permission.coding.id
                Definition

                Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                ShortUnique id for inter-element referencing
                Control0..1
                This element is affected by the following invariants: ele-1
                Typeid
                Is Modifierfalse
                XML FormatIn the XML format, this property is represented as an attribute.
                Summaryfalse
                36. Consent.category:permission.coding.extension
                Definition

                May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                ShortAdditional content defined by implementations
                Comments

                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.

                Control0..*
                TypeExtension
                Is Modifierfalse
                Summaryfalse
                Alternate Namesextensions, user content
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                SlicingThis element introduces a set of slices on Consent.category.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 38. Consent.category:permission.coding.system
                  Definition

                  The identification of the code system that defines the meaning of the symbol in the code.

                  ShortIdentity of the terminology system
                  Comments

                  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 be an absolute reference to some definition that establishes the system clearly and unambiguously.

                  Control1..1
                  Typeuri
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Must Supporttrue
                  Summarytrue
                  Requirements

                  Need to be unambiguous about the source of the definition of the symbol.

                  Pattern Valuehttps://fhir.savannahghi.org/ig/healthy-route/CodeSystem/hr-consent-permission
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  40. Consent.category:permission.coding.version
                  Definition

                  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.

                  ShortVersion of the system - if relevant
                  Comments

                  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.

                  NoteThis is a business version Id, not a resource version Id (see discussion)
                  Control0..1
                  Typestring
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  42. Consent.category:permission.coding.code
                  Definition

                  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).

                  ShortSymbol in syntax defined by the system
                  Control0..1
                  This element is affected by the following invariants: cod-1
                  Typecode
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Requirements

                  Need to refer to a particular code in the system.

                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  44. Consent.category:permission.coding.display
                  Definition

                  A representation of the meaning of the code in the system, following the rules of the system.

                  ShortRepresentation defined by the system
                  Control0..1
                  This element is affected by the following invariants: cod-1
                  Typestring
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Requirements

                  Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  46. Consent.category:permission.coding.userSelected
                  Definition

                  Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                  ShortIf this coding was chosen directly by the user
                  Comments

                  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.

                  Control0..1
                  Typeboolean
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Requirements

                  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.

                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  48. Consent.category:permission.text
                  Definition

                  A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                  ShortPlain text representation of the concept
                  Comments

                  Very often the text is the same as a displayName of one of the codings.

                  Control0..1
                  Typestring
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Requirements

                  The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  50. Consent.subject
                  Definition

                  The patient/healthcare practitioner or group of persons to whom this consent applies.

                  ShortWho the consent applies to
                  Comments

                  Constrained to Patient. Consent is never taken from a practitioner or a group in this study, and the base resource permits both.

                  Control1..1
                  TypeReference(Healthy Route Patient)
                  Is Modifierfalse
                  Must Supporttrue
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  52. Consent.date
                  Definition

                  Date the consent instance was agreed to.

                  ShortDate the participant signed
                  Comments

                  The date on the paper form, which may precede the date the record was created.

                  Control1..1
                  Typedate
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Must Supporttrue
                  Summarytrue
                  Requirements

                  Compared against the date of the earliest study activity. An encounter, specimen or image dated before this is a protocol deviation, and the comparison is only possible if the signature date rather than the data entry date is recorded here.

                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  54. Consent.period
                  Definition

                  Effective period for this Consent Resource and all provisions unless specified in that provision.

                  ShortPeriod over which the permission applies
                  Comments

                  Distinct from the retention period stated in the information sheet. Present where the permission itself is time limited.

                  Control0..1
                  TypePeriod
                  Is Modifierfalse
                  Must Supporttrue
                  Summarytrue
                  Alternate Namesperiod
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  56. Consent.grantor
                  Definition

                  The entity responsible for granting the rights listed in a Consent Directive.

                  ShortWho is granting rights according to the policy and rules
                  Comments

                  Ordinarily the participant. RelatedPerson is admitted because both protocols provide for consent given by a legally authorised representative, and an earlier version of this profile constrained the element to Patient while its own comment said the resource must not preclude that. Where a representative consents, subject remains the participant and grantor is the representative, which is the distinction the two elements exist to carry.

                  Control1..1
                  TypeReference(Healthy Route Patient, RelatedPerson)
                  Is Modifierfalse
                  Must Supporttrue
                  Must Support TypesNo must-support rules about the choice of types/profiles
                  Summarytrue
                  Alternate Namesgrantor
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  58. Consent.grantee
                  Definition

                  The entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations and enforcement of prohibitions.

                  ShortParty the permission is granted to
                  Comments

                  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.

                  Control1..*
                  TypeReference(Healthy Route Organization)
                  Is Modifierfalse
                  Must Supporttrue
                  Summarytrue
                  Requirements

                  The information sheet names the parties who will hold the data. Where a permission extends beyond the site to a party receiving the exported data, both appear here, and a permission naming only the site does not authorise transfer.

                  Alternate Namesgrantee
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  60. Consent.manager
                  Definition

                  The actor that manages the consent through its lifecycle.

                  ShortConsent workflow management
                  Control0..*
                  TypeReference(HealthcareService, Organization, Patient, Practitioner)
                  Is Modifierfalse
                  Must Supportfalse
                  Summaryfalse
                  Alternate Namesmanager
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  62. Consent.controller
                  Definition

                  The actor that controls/enforces the access according to the consent.

                  ShortData controller
                  Control0..*
                  TypeReference(Healthy Route Organization)
                  Is Modifierfalse
                  Must Supporttrue
                  Summaryfalse
                  Alternate Namescontroller
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  64. Consent.sourceAttachment
                  Definition

                  The source on which this consent statement is based. The source might be a scanned original paper form.

                  ShortSource from which this consent is taken
                  Comments

                  The source can be contained inline (Attachment), referenced directly (Consent), referenced in a consent repository (DocumentReference), or simply by an identifier (Identifier), e.g. a CDA document id.

                  Control0..*
                  TypeAttachment
                  Is Modifierfalse
                  Must Supportfalse
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  66. Consent.sourceReference
                  Definition

                  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.

                  ShortThe photographed signed page
                  Comments

                  Optional, and expected to be absent at most sites. The protocol requires the investigator to retain the signed form and states that no records may be transferred to another location or party without written notification to the sponsor; it requires the medical record to carry a statement that consent was obtained and the date, which this resource satisfies without an image. Present only where a site has chosen to hold a photograph of the page within its own tenant and its ethics committee has approved that, which is a decision beyond the protocol rather than one it mandates.

                  Control0..1
                  TypeReference(Healthy Route Consent Evidence)
                  Is Modifierfalse
                  Must Supporttrue
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  68. Consent.regulatoryBasis
                  Definition

                  A set of codes that indicate the regulatory basis (if any) that this consent supports.

                  ShortRegulatory framework the consent was taken under
                  Comments

                  The national research regulation that governs the site, which differs between participating countries. Country variation is carried on instances rather than by separate profiles.

                  Control0..*
                  BindingFor example codes, see ConsentPolicyRuleCodes
                  (example to http://hl7.org/fhir/ValueSet/consent-policy|5.0.0)

                  Regulatory policy examples

                  TypeCodeableConcept
                  Is Modifierfalse
                  Must Supporttrue
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  70. Consent.policyBasis
                  Definition

                  A Reference or URL used to uniquely identify the policy the organization will enforce for this Consent. This Reference or URL should be specific to the version of the policy and should be dereferencable to a computable policy of some form.

                  ShortComputable version of the backing policy
                  Control1..1
                  TypeBackboneElement
                  Is Modifierfalse
                  Must Supporttrue
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  72. Consent.policyBasis.id
                  Definition

                  Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                  ShortUnique id for inter-element referencing
                  Control0..1
                  This element is affected by the following invariants: ele-1
                  Typestring
                  Is Modifierfalse
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Summaryfalse
                  74. Consent.policyBasis.extension
                  Definition

                  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                  ShortAdditional content defined by implementations
                  Comments

                  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.

                  Control0..*
                  TypeExtension
                  Is Modifierfalse
                  Summaryfalse
                  Alternate Namesextensions, user content
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  76. Consent.policyBasis.modifierExtension
                  Definition

                  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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

                  Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                  ShortExtensions that cannot be ignored even if unrecognized
                  Comments

                  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.

                  Control0..*
                  TypeExtension
                  Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                  Summarytrue
                  Requirements

                  Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                  Alternate Namesextensions, user content, modifiers
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  78. Consent.policyBasis.reference
                  Definition

                  A Reference that identifies the policy the organization will enforce for this Consent.

                  ShortReference backing policy resource
                  Comments

                  While any resource may be used, Consent, PlanDefinition and Contract would be most frequent

                  Control0..1
                  TypeReference(Resource)
                  Is Modifierfalse
                  Must Supportfalse
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  80. Consent.policyBasis.url
                  Definition

                  A URL that links to a computable version of the policy the organization will enforce for this Consent.

                  ShortVersioned identifier of the approved information sheet
                  Comments

                  Identifies a version, not a document to display. The document itself is referenced from policyText.

                  Control1..1
                  Typeurl
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Must Supporttrue
                  Summaryfalse
                  Requirements

                  Ethics committees approve a specific version of the participant information sheet and consent form. Establishing which version a participant was shown is the first question asked when a form is amended mid-study, and it cannot be answered from the signature alone.

                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  82. Consent.policyText
                  Definition

                  A Reference to the human readable policy explaining the basis for the Consent.

                  ShortThe approved blank information sheet and consent form
                  Comments

                  The unsigned template as approved, identical for every participant given that version. Not to be confused with sourceReference, which is the individual signed page and is identifying.

                  Control0..*
                  TypeReference(Healthy Route Document)
                  Is Modifierfalse
                  Must Supporttrue
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  84. Consent.verification
                  Definition

                  Whether a treatment instruction (e.g. artificial respiration: yes or no) was verified with the patient, his/her family or another authorized person.

                  ShortConsent Verified by patient or family
                  Control1..1
                  TypeBackboneElement
                  Is Modifierfalse
                  Must Supporttrue
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  86. Consent.verification.id
                  Definition

                  Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                  ShortUnique id for inter-element referencing
                  Control0..1
                  This element is affected by the following invariants: ele-1
                  Typestring
                  Is Modifierfalse
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Summaryfalse
                  88. Consent.verification.extension
                  Definition

                  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                  ShortAdditional content defined by implementations
                  Comments

                  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.

                  Control0..*
                  TypeExtension
                  Is Modifierfalse
                  Summaryfalse
                  Alternate Namesextensions, user content
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  90. Consent.verification.modifierExtension
                  Definition

                  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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

                  Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                  ShortExtensions that cannot be ignored even if unrecognized
                  Comments

                  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.

                  Control0..*
                  TypeExtension
                  Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                  Summarytrue
                  Requirements

                  Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                  Alternate Namesextensions, user content, modifiers
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  92. Consent.verification.verified
                  Definition

                  Has the instruction been verified.

                  ShortHas been verified
                  Control1..1
                  Typeboolean
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Must Supporttrue
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  94. Consent.verification.verificationType
                  Definition

                  Extensible list of verification type starting with verification and re-validation.

                  ShortBusiness case of verification
                  Comments

                  This allows the verification element to hold multiple use cases including RelatedPerson verification of the Grantee decision and periodic re-validation of the consent.

                  Control0..1
                  BindingFor example codes, see ConsentVerificationCodes
                  (example to http://hl7.org/fhir/ValueSet/consent-verification|5.0.0)

                  Types of Verification/Validation.

                  TypeCodeableConcept
                  Is Modifierfalse
                  Must Supportfalse
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  96. Consent.verification.verifiedBy
                  Definition

                  The person who conducted the verification/validation of the Grantor decision.

                  ShortPerson who took consent
                  Comments

                  The individual, not the organisation and not the role they held. The base resource admits all three; an organisation cannot be delegated to take consent, and recording the role rather than the person would leave the identity of the signatory on the paper form unmatched in the record. Where the delegation itself needs to be established, a PractitionerRole referring to the same practitioner carries it.

                  Control1..1
                  TypeReference(Healthy Route Practitioner)
                  Is Modifierfalse
                  Must Supporttrue
                  Summaryfalse
                  Requirements

                  Good clinical practice requires that consent be taken by a person authorised to do so on the delegation log, and the protocol requires that person to sign the form. Recording who took it is what allows that authorisation to be checked after the fact.

                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  98. Consent.verification.verifiedWith
                  Definition

                  Who verified the instruction (Patient, Relative or other Authorized Person).

                  ShortPerson who verified
                  Control0..1
                  TypeReference(Patient, RelatedPerson)
                  Is Modifierfalse
                  Must Supportfalse
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  100. Consent.verification.verificationDate
                  Definition

                  Date(s) verification was collected.

                  ShortWhen consent verified
                  Comments

                  Allows for history of verification/validation.

                  Control1..1
                  TypedateTime
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Must Supporttrue
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  102. Consent.decision
                  Definition

                  Action to take - permit or deny - as default.

                  Shortpermit or deny
                  Comments

                  A refusal is recorded as an active consent with a decision of deny, not as an absent resource. The distinction between a participant who declined and a participant who was never asked is material at audit.

                  Control1..1
                  BindingThe codes SHALL be taken from ConsentProvisionType
                  (required to http://hl7.org/fhir/ValueSet/consent-provision-type|5.0.0)

                  Sets the base decision for Consent to be either permit or deny, with provisions assumed to be a negation of the previous level.

                  Typecode
                  Is Modifiertrue because Sets context for the values in .provision
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Must Supporttrue
                  Summarytrue
                  Requirements

                  Required, where the base resource makes it optional. A consent record whose decision is absent cannot be acted on, and its absence is indistinguishable from a refusal that was never recorded.

                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  104. Consent.provision
                  Definition

                  An exception to the base policy of this consent. An exception can be an addition or removal of access permissions.

                  ShortConstraints to the base Consent.policyRule/Consent.policy
                  Control0..*
                  TypeBackboneElement
                  Is Modifierfalse
                  Must Supportfalse
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  106. Consent.provision.id
                  Definition

                  Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                  ShortUnique id for inter-element referencing
                  Control0..1
                  This element is affected by the following invariants: ele-1
                  Typestring
                  Is Modifierfalse
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Summaryfalse
                  108. Consent.provision.extension
                  Definition

                  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                  ShortAdditional content defined by implementations
                  Comments

                  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.

                  Control0..*
                  TypeExtension
                  Is Modifierfalse
                  Summaryfalse
                  Alternate Namesextensions, user content
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  110. Consent.provision.modifierExtension
                  Definition

                  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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

                  Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                  ShortExtensions that cannot be ignored even if unrecognized
                  Comments

                  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.

                  Control0..*
                  TypeExtension
                  Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                  Summarytrue
                  Requirements

                  Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                  Alternate Namesextensions, user content, modifiers
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  112. Consent.provision.period
                  Definition

                  Timeframe for this provision.

                  ShortTimeframe for this provision
                  Comments

                  This is the bound effective time of the consent and should be in the base provision in the Consent resource.

                  Control0..1
                  TypePeriod
                  Is Modifierfalse
                  Must Supportfalse
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  114. Consent.provision.actor
                  Definition

                  Who or what is controlled by this provision. Use group to identify a set of actors by some property they share (e.g. 'admitting officers').

                  ShortWho|what controlled by this provision (or group, by role)
                  Control0..*
                  TypeBackboneElement
                  Is Modifierfalse
                  Must Supportfalse
                  Summaryfalse
                  Meaning if MissingThere is no specific actor associated with the exception
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  116. Consent.provision.actor.id
                  Definition

                  Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                  ShortUnique id for inter-element referencing
                  Control0..1
                  This element is affected by the following invariants: ele-1
                  Typestring
                  Is Modifierfalse
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Summaryfalse
                  118. Consent.provision.actor.extension
                  Definition

                  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                  ShortAdditional content defined by implementations
                  Comments

                  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.

                  Control0..*
                  TypeExtension
                  Is Modifierfalse
                  Summaryfalse
                  Alternate Namesextensions, user content
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  120. Consent.provision.actor.modifierExtension
                  Definition

                  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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

                  Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                  ShortExtensions that cannot be ignored even if unrecognized
                  Comments

                  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.

                  Control0..*
                  TypeExtension
                  Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                  Summarytrue
                  Requirements

                  Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                  Alternate Namesextensions, user content, modifiers
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  122. Consent.provision.actor.role
                  Definition

                  How the individual is involved in the resources content that is described in the exception.

                  ShortHow the actor is involved
                  Control0..1
                  BindingUnless not suitable, these codes SHALL be taken from ParticipationRoleType
                  (extensible to http://hl7.org/fhir/ValueSet/participation-role-type|5.0.0)

                  How an actor is involved in the consent considerations.

                  TypeCodeableConcept
                  Is Modifierfalse
                  Must Supportfalse
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  124. Consent.provision.actor.reference
                  Definition

                  The resource that identifies the actor. To identify actors by type, use group to identify a set of actors by some property they share (e.g. 'admitting officers').

                  ShortResource for the actor (or group, by role)
                  Control0..1
                  TypeReference(Device, Group, CareTeam, Organization, Patient, Practitioner, RelatedPerson, PractitionerRole)
                  Is Modifierfalse
                  Must Supportfalse
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  126. Consent.provision.action
                  Definition

                  Actions controlled by this provision.

                  ShortActions controlled by this provision
                  Comments

                  Note that this is the direct action (not the grounds for the action covered in the purpose element). At present, the only action in the understood and tested scope of this resource is 'read'.

                  Control0..*
                  BindingFor example codes, see ConsentActionCodes
                  (example to http://hl7.org/fhir/ValueSet/consent-action|5.0.0)

                  Detailed codes for the consent action.

                  TypeCodeableConcept
                  Is Modifierfalse
                  Must Supportfalse
                  Summarytrue
                  Meaning if Missingall actions
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  128. Consent.provision.securityLabel
                  Definition

                  A security label, comprised of 0..* security label fields (Privacy tags), which define which resources are controlled by this exception.

                  ShortSecurity Labels that define affected resources
                  Comments

                  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. When the purpose of use tag is on the data, access request purpose of use shall not conflict.

                  Control0..*
                  BindingFor example codes, see SecurityLabelExamples
                  (example to http://hl7.org/fhir/ValueSet/security-label-examples|5.0.0)

                  Example Security Labels from the Healthcare Privacy and Security Classification System.

                  TypeCoding
                  Is Modifierfalse
                  Must Supportfalse
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  130. Consent.provision.purpose
                  Definition

                  The context of the activities a user is taking - why the user is accessing the data - that are controlled by this provision.

                  ShortContext of activities covered by this provision
                  Comments

                  When the purpose of use tag is on the data, access request purpose of use shall not conflict.

                  Control0..*
                  BindingUnless not suitable, these codes SHALL be taken from PurposeOfUse
                  (extensible to http://terminology.hl7.org/ValueSet/v3-PurposeOfUse)

                  What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels.

                  TypeCoding
                  Is Modifierfalse
                  Must Supportfalse
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  132. Consent.provision.documentType
                  Definition

                  The documentType(s) covered by this provision. The type can be a CDA document, or some other type that indicates what sort of information the consent relates to.

                  Shorte.g. Resource Type, Profile, CDA, etc
                  Comments

                  Multiple types are or'ed together. The intention of the documentType element is that the codes refer to document types defined in a standard somewhere.

                  Control0..*
                  BindingThe codes SHOULD be taken from ConsentContentClass
                  (preferred to http://hl7.org/fhir/ValueSet/consent-content-class|5.0.0)

                  The document type a consent provision covers.

                  TypeCoding
                  Is Modifierfalse
                  Must Supportfalse
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  134. Consent.provision.resourceType
                  Definition

                  The resourceType(s) covered by this provision. The type can be a FHIR resource type or a profile on a type that indicates what information the consent relates to.

                  Shorte.g. Resource Type, Profile, etc
                  Comments

                  Multiple types are or'ed together. The intention of the resourceType element is that the codes refer to profiles or document types defined in a standard or an implementation guide somewhere.

                  Control0..*
                  BindingUnless not suitable, these codes SHALL be taken from ResourceType
                  (extensible to http://hl7.org/fhir/ValueSet/resource-types|5.0.0)

                  The resource types a consent provision covers.

                  TypeCoding
                  Is Modifierfalse
                  Must Supportfalse
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  136. Consent.provision.code
                  Definition

                  If this code is found in an instance, then the provision applies.

                  Shorte.g. LOINC or SNOMED CT code, etc. in the content
                  Control0..*
                  BindingFor example codes, see ConsentContentCodes
                  (example to http://hl7.org/fhir/ValueSet/consent-content-code|5.0.0)

                  If this code is found in an instance, then the exception applies.

                  TypeCodeableConcept
                  Is Modifierfalse
                  Must Supportfalse
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  138. Consent.provision.dataPeriod
                  Definition

                  Clinical or Operational Relevant period of time that bounds the data controlled by this provision.

                  ShortTimeframe for data controlled by this provision
                  Comments

                  This has a different sense to the Consent.period - that is when the consent agreement holds. This is the time period of the data that is controlled by the agreement.

                  Control0..1
                  TypePeriod
                  Is Modifierfalse
                  Must Supportfalse
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  140. Consent.provision.data
                  Definition

                  The resources controlled by this provision if specific resources are referenced.

                  ShortData controlled by this provision
                  Control0..*
                  TypeBackboneElement
                  Is Modifierfalse
                  Must Supportfalse
                  Summarytrue
                  Meaning if Missingall data
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  142. Consent.provision.data.id
                  Definition

                  Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                  ShortUnique id for inter-element referencing
                  Control0..1
                  This element is affected by the following invariants: ele-1
                  Typestring
                  Is Modifierfalse
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Summaryfalse
                  144. Consent.provision.data.extension
                  Definition

                  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                  ShortAdditional content defined by implementations
                  Comments

                  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.

                  Control0..*
                  TypeExtension
                  Is Modifierfalse
                  Summaryfalse
                  Alternate Namesextensions, user content
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  146. Consent.provision.data.modifierExtension
                  Definition

                  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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

                  Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                  ShortExtensions that cannot be ignored even if unrecognized
                  Comments

                  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.

                  Control0..*
                  TypeExtension
                  Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                  Summarytrue
                  Requirements

                  Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                  Alternate Namesextensions, user content, modifiers
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  148. Consent.provision.data.meaning
                  Definition

                  How the resource reference is interpreted when testing consent restrictions.

                  Shortinstance | related | dependents | authoredby
                  Control1..1
                  BindingThe codes SHALL be taken from ConsentDataMeaning
                  (required to http://hl7.org/fhir/ValueSet/consent-data-meaning|5.0.0)

                  How a resource reference is interpreted when testing consent restrictions.

                  Typecode
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Must Supportfalse
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  150. Consent.provision.data.reference
                  Definition

                  A reference to a specific resource that defines which resources are covered by this consent.

                  ShortThe actual data reference
                  Control1..1
                  TypeReference(Resource)
                  Is Modifierfalse
                  Must Supportfalse
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  152. Consent.provision.expression
                  Definition

                  A computable (FHIRPath or other) definition of what is controlled by this consent.

                  ShortA computable expression of the consent
                  Comments

                  Constraining the expression type for a specific implementation via profile is recommended

                  Control0..1
                  TypeExpression
                  Is Modifierfalse
                  Must Supportfalse
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  154. Consent.provision.provision
                  Definition

                  Provisions which provide exceptions to the base provision or subprovisions.

                  ShortNested Exception Provisions
                  Control0..*
                  TypeSeettp://hl7.org/fhir/StructureDefinition/Consent#Consent.provision
                  Is Modifierfalse
                  Must Supportfalse
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))