SGHI FHIR Profile Implementation Guide
0.1.0 - ci-build

SGHI FHIR Profile Implementation Guide, published by Kathurima Kimathi. 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/sil_fhir_profile_ig/ and changes regularly. See the Directory of published versions

## Resource Profile: SGHIConsent - Detailed Descriptions

Draft as of 2026-04-27

Definitions for the consent resource profile.

- Key Elements Table
- Differential Elements Table
- Snapshot Elements Table

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.
Short | A 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.
Control | 0..*
Is Modifier | false
Must Support | false
Summary | false
Invariants | dom-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.
Short | A 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.
Control | 0..1
Type | uri
Is Modifier | true 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 Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-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.
Short | Contained, 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.
Control | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
Type | Resource
Is Modifier | false
Must Support | false
Summary | false
Alternate Names | inline resources, anonymous resources, contained resources
6. 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).
Short | Extensions 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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Must Support | false
Summary | true
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 Names | extensions, user content
Invariants | ele-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())
8. Consent.identifier
Definition | Unique identifier for this copy of the Consent Statement.
Short | Identifier 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.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 10..*
Type | Identifier
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. Consent.identifier.use
Definition | The purpose of this identifier.
Short | usual | official | temp | secondary | old (If known)
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Control | 0..1
Binding | The codes SHALL be taken from IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 (required to `http://hl7.org/fhir/ValueSet/identifier-use` )
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. Consent.identifier.type
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Short | Description of identifier
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Control | 0..1
Binding | The codes SHALL be taken from Unless not suitable, these codes SHALL be taken from SGHI Default Identifier Types http://hl7.org/fhir/ValueSet/identifier-type|5.0.0 (required to `https://fhir.slade360.co.ke/fhir/ValueSet/default-identifier-types` )
Type | CodeableConcept(SGHI CodeableConcept)
Is Modifier | false
Summary | true
Requirements | Allows users to make use of identifiers when the identifier system is not known.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. Consent.identifier.system
Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.
Short | The namespace for the identifier value
Comments | Identifier.system is always case sensitive.
Control | 10..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Example | General: http://www.acme.com/identifiers/patient
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. Consent.identifier.value
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Short | The value that is unique
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Control | 10..1 This element is affected by the following invariants: ident-1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Example | General: 123456
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. Consent.identifier.assigner
Definition | Organization that issued/manages the identifier.
Short | Organization that issued id (may be just text)
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Control | 10..1
Type | Reference(SGHI Reference)(SGHI Organization, Organization)
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. Consent.status
Definition | Indicates the current state of this Consent resource.
Short | draft | active | inactive | not-done | entered-in-error | unknown
Comments | 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.
Control | 1..1
Binding | The codes SHALL be taken from ConsentState http://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.
Type | code
Is Modifier | true 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 Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. Consent.category
Definition | A classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements.
Short | Classification of the consent statement - for indexing/retrieval
Control | 10..*
Binding | For example codes, see ConsentCategoryCodes http://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.
Type | CodeableConcept(SGHI CodeableConcept)
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. Consent.subject
Definition | The patient/healthcare practitioner or group of persons to whom this consent applies.
Short | Who the consent applies to
Control | 10..1
Type | Reference(SGHI Reference)(SGHI Patient, Patient, Practitioner, Group)
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. Consent.date
Definition | Date the consent instance was agreed to.
Short | Fully executed date of the consent
Control | 10..1
Type | date
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-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.
Short | Who is granting rights according to the policy and rules
Control | 10..1*
Type | Reference(SGHI Reference)(SGHI Organization, SGHI Patient, CareTeam, HealthcareService, Organization, Patient, Practitioner, RelatedPerson, PractitionerRole)
Is Modifier | false
Must Support | false
Summary | true
Alternate Names | grantor
Invariants | ele-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.
Short | Who 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.
Control | 10..1*
Type | Reference(SGHI Reference)(SGHI Patient, SGHI Organization, CareTeam, HealthcareService, Organization, Patient, Practitioner, RelatedPerson, PractitionerRole)
Is Modifier | false
Must Support | false
Summary | true
Alternate Names | grantee
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. Consent.manager
Definition | The actor that manages the consent through its lifecycle.
Short | Consent workflow management
Control | 10..*
Type | Reference(SGHI Reference)(SGHI Organization, SGHI Patient, HealthcareService, Organization, Patient, Practitioner)
Is Modifier | false
Must Support | false
Summary | false
Alternate Names | manager
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
34. Consent.controller
Definition | The actor that controls/enforces the access according to the consent.
Short | Consent Enforcer
Control | 10..1*
Type | Reference(SGHI Reference)(SGHI Organization, SGHI Patient, HealthcareService, Organization, Patient, Practitioner)
Is Modifier | false
Must Support | false
Summary | false
Alternate Names | controller
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. Consent.sourceAttachment
Definition | The source on which this consent statement is based. The source might be a scanned original paper form.
Short | Source from which this consent is taken
Comments | The source can be contained inline (Attachment), referenced directly (Consent), referenced in a consent repository (DocumentReference), or simply by an identifier (Identifier), e.g. a CDA document id.
Control | 0..*
Type | Attachment(SGHI Attachment)
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. 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.
Short | Source from which this consent is taken
Comments | The source can be contained inline (Attachment), referenced directly (Consent), referenced in a consent repository (DocumentReference), or simply by an identifier (Identifier), e.g. a CDA document id.
Control | 0..*
Type | Reference(SGHI Reference)(SGHI Consent, Consent, DocumentReference, Contract, QuestionnaireResponse)
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
40. Consent.regulatoryBasis
Definition | A set of codes that indicate the regulatory basis (if any) that this consent supports.
Short | Regulations establishing base Consent
Control | 0..*
Binding | For example codes, see ConsentPolicyRuleCodes http://hl7.org/fhir/ValueSet/consent-policy|5.0.0 (example to `http://hl7.org/fhir/ValueSet/consent-policy|5.0.0` ) Regulatory policy examples
Type | CodeableConcept(SGHI CodeableConcept)
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
42. Consent.policyText
Definition | A Reference to the human readable policy explaining the basis for the Consent.
Short | Human Readable Policy
Control | 0..*
Type | Reference(SGHI Reference)(DocumentReference, DocumentReference)
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
44. 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.
Short | Consent Verified by patient or family
Control | 10..*
Type | BackboneElement
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
46. 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).
Short | Extensions 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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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 Names | extensions, user content, modifiers
Invariants | ele-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())
48. Consent.verification.verified
Definition | Has the instruction been verified.
Short | Has been verified
Control | 1..1
Type | boolean
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
50. Consent.verification.verificationType
Definition | Extensible list of verification type starting with verification and re-validation.
Short | Business 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.
Control | 0..1
Binding | For example codes, see ConsentVerificationCodes http://hl7.org/fhir/ValueSet/consent-verification|5.0.0 (example to `http://hl7.org/fhir/ValueSet/consent-verification|5.0.0` ) Types of Verification/Validation.
Type | CodeableConcept(SGHI CodeableConcept)
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-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.
Short | Person conducting verification
Control | 10..1
Type | Reference(SGHI Reference)(SGHI Organization, Organization, Practitioner, PractitionerRole)
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
54. Consent.verification.verifiedWith
Definition | Who verified the instruction (Patient, Relative or other Authorized Person).
Short | Person who verified
Control | 10..1
Type | Reference(SGHI Reference)(SGHI Patient, Patient, RelatedPerson)
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
56. Consent.verification.verificationDate
Definition | Date(s) verification was collected.
Short | When consent verified
Comments | Allows for history of verification/validation.
Control | 10..1*
Type | dateTime
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
58. Consent.decision
Definition | Action to take - permit or deny - as default.
Short | deny | permit
Control | 10..1
Binding | The codes SHALL be taken from ConsentProvisionType http://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.
Type | code
Is Modifier | true because Sets context for the values in .provision
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-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.identifier
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 1..?
4. Consent.identifier.use
Binding | The codes SHALL be taken from IdentifierUse (required to `http://hl7.org/fhir/ValueSet/identifier-use` )
6. Consent.identifier.type
Binding | The codes SHALL be taken from SGHI Default Identifier Types (required to `https://fhir.slade360.co.ke/fhir/ValueSet/default-identifier-types` )
Type | CodeableConcept(SGHI CodeableConcept)
8. Consent.identifier.system
Control | 1..?
10. Consent.identifier.value
Control | 1..?
12. Consent.identifier.assigner
Control | 1..?
Type | Reference(SGHI Reference)(SGHI Organization)
14. Consent.category
Control | 1..?
Type | CodeableConcept(SGHI CodeableConcept)
16. Consent.subject
Control | 1..?
Type | Reference(SGHI Reference)(SGHI Patient)
18. Consent.date
Control | 1..?
20. Consent.grantor
Control | 1..1
Type | Reference(SGHI Reference)(SGHI Organization, SGHI Patient)
22. Consent.grantee
Control | 1..1
Type | Reference(SGHI Reference)(SGHI Patient, SGHI Organization)
24. Consent.manager
Control | 1..?
Type | Reference(SGHI Reference)(SGHI Organization, SGHI Patient)
26. Consent.controller
Control | 1..1
Type | Reference(SGHI Reference)(SGHI Organization, SGHI Patient)
28. Consent.sourceAttachment
Type | Attachment(SGHI Attachment)
Must Support | true
30. Consent.sourceReference
Type | Reference(SGHI Reference)(SGHI Consent)
32. Consent.regulatoryBasis
Type | CodeableConcept(SGHI CodeableConcept)
34. Consent.policyBasis
36. Consent.policyBasis.reference
Type | Reference(SGHI Reference)(Resource)
38. Consent.policyText
Type | Reference(SGHI Reference)(DocumentReference)
40. Consent.verification
Control | 1..?
42. Consent.verification.verificationType
Type | CodeableConcept(SGHI CodeableConcept)
44. Consent.verification.verifiedBy
Control | 1..?
Type | Reference(SGHI Reference)(SGHI Organization)
46. Consent.verification.verifiedWith
Control | 1..?
Type | Reference(SGHI Reference)(SGHI Patient)
48. Consent.verification.verificationDate
Control | 1..1
50. Consent.decision
Control | 1..?
52. Consent.provision
54. Consent.provision.actor
56. Consent.provision.actor.role
Type | CodeableConcept(SGHI CodeableConcept)
58. Consent.provision.actor.reference
Type | Reference(SGHI Reference)(SGHI Patient, SGHI Organization)
60. Consent.provision.action
Type | CodeableConcept(SGHI CodeableConcept)
62. Consent.provision.code
Binding | The codes SHALL be taken from ConsentContentCodes (required to `http://hl7.org/fhir/ValueSet/consent-content-code` )
Type | CodeableConcept(SGHI CodeableConcept)
64. Consent.provision.data
66. Consent.provision.data.reference
Type | Reference(SGHI Reference)(Resource)

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.
Short | A 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.
Control | 0..*
Is Modifier | false
Must Support | false
Summary | false
Invariants | dom-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.
Short | Logical 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.
Control | 0..1
Type | id
Is Modifier | false
Must Support | false
Summary | true
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.
Short | Metadata about the resource
Control | 0..1
Type | Meta
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-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.
Short | A 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.
Control | 0..1
Type | uri
Is Modifier | true 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 Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-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.
Short | Language 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).
Control | 0..1
Binding | The 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
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-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.
Short | Text 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.
Control | 0..1 This element is affected by the following invariants: dom-6
Type | Narrative
Is Modifier | false
Must Support | false
Summary | false
Alternate Names | narrative, html, xhtml, display
Invariants | ele-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.
Short | Contained, 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.
Control | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
Type | Resource
Is Modifier | false
Must Support | false
Summary | false
Alternate Names | inline resources, anonymous resources, contained resources
14. Consent.extension
Definition | 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.
Short | Additional 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.
Control | 0..*
Type | Extension
Is Modifier | false
Must Support | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-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()`)
16. 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).
Short | Extensions 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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Must Support | false
Summary | true
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 Names | extensions, user content
Invariants | ele-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.identifier
Definition | Unique identifier for this copy of the Consent Statement.
Short | Identifier 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.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 1..*
Type | Identifier
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
20. Consent.identifier.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | id
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
22. Consent.identifier.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.
Short | Additional 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-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()`)
Slicing | This element introduces a set of slices on `Consent.identifier.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
24. Consent.identifier.use
Definition | The purpose of this identifier.
Short | usual | official | temp | secondary | old (If known)
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Control | 0..1
Binding | The codes SHALL be taken from IdentifierUse (required to `http://hl7.org/fhir/ValueSet/identifier-use` )
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
26. Consent.identifier.type
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Short | Description of identifier
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Control | 0..1
Binding | The codes SHALL be taken from SGHI Default Identifier Types (required to `https://fhir.slade360.co.ke/fhir/ValueSet/default-identifier-types` )
Type | CodeableConcept(SGHI CodeableConcept)
Is Modifier | false
Summary | true
Requirements | Allows users to make use of identifiers when the identifier system is not known.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
28. Consent.identifier.system
Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.
Short | The namespace for the identifier value
Comments | Identifier.system is always case sensitive.
Control | 1..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Example | General: http://www.acme.com/identifiers/patient
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
30. Consent.identifier.value
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Short | The value that is unique
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Control | 1..1 This element is affected by the following invariants: ident-1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Example | General: 123456
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
32. Consent.identifier.period
Definition | Time period during which identifier is/was valid for use.
Short | Time period when id is/was valid for use
Control | 0..1
Type | Period
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
34. Consent.identifier.assigner
Definition | Organization that issued/manages the identifier.
Short | Organization that issued id (may be just text)
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Control | 1..1
Type | Reference(SGHI Reference)(SGHI Organization)
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
36. Consent.status
Definition | Indicates the current state of this Consent resource.
Short | draft | active | inactive | not-done | entered-in-error | unknown
Comments | 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.
Control | 1..1
Binding | The 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.
Type | code
Is Modifier | true 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 Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
38. Consent.category
Definition | A classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements.
Short | Classification of the consent statement - for indexing/retrieval
Control | 1..*
Binding | For 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.
Type | CodeableConcept(SGHI CodeableConcept)
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
40. Consent.subject
Definition | The patient/healthcare practitioner or group of persons to whom this consent applies.
Short | Who the consent applies to
Control | 1..1
Type | Reference(SGHI Reference)(SGHI Patient)
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
42. Consent.date
Definition | Date the consent instance was agreed to.
Short | Fully executed date of the consent
Control | 1..1
Type | date
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
44. Consent.period
Definition | Effective period for this Consent Resource and all provisions unless specified in that provision.
Short | Effective period for this Consent
Control | 0..1
Type | Period
Is Modifier | false
Must Support | false
Summary | true
Alternate Names | period
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
46. Consent.grantor
Definition | The entity responsible for granting the rights listed in a Consent Directive.
Short | Who is granting rights according to the policy and rules
Control | 1..1
Type | Reference(SGHI Reference)(SGHI Organization, SGHI Patient)
Is Modifier | false
Must Support | false
Summary | true
Alternate Names | grantor
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
48. Consent.grantee
Definition | The entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations and enforcement of prohibitions.
Short | Who 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.
Control | 1..1
Type | Reference(SGHI Reference)(SGHI Patient, SGHI Organization)
Is Modifier | false
Must Support | false
Summary | true
Alternate Names | grantee
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
50. Consent.manager
Definition | The actor that manages the consent through its lifecycle.
Short | Consent workflow management
Control | 1..*
Type | Reference(SGHI Reference)(SGHI Organization, SGHI Patient)
Is Modifier | false
Must Support | false
Summary | false
Alternate Names | manager
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
52. Consent.controller
Definition | The actor that controls/enforces the access according to the consent.
Short | Consent Enforcer
Control | 1..1
Type | Reference(SGHI Reference)(SGHI Organization, SGHI Patient)
Is Modifier | false
Must Support | false
Summary | false
Alternate Names | controller
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
54. Consent.sourceAttachment
Definition | The source on which this consent statement is based. The source might be a scanned original paper form.
Short | Source from which this consent is taken
Comments | The source can be contained inline (Attachment), referenced directly (Consent), referenced in a consent repository (DocumentReference), or simply by an identifier (Identifier), e.g. a CDA document id.
Control | 0..*
Type | Attachment(SGHI Attachment)
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
56. 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.
Short | Source from which this consent is taken
Comments | The source can be contained inline (Attachment), referenced directly (Consent), referenced in a consent repository (DocumentReference), or simply by an identifier (Identifier), e.g. a CDA document id.
Control | 0..*
Type | Reference(SGHI Reference)(SGHI Consent)
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
58. Consent.regulatoryBasis
Definition | A set of codes that indicate the regulatory basis (if any) that this consent supports.
Short | Regulations establishing base Consent
Control | 0..*
Binding | For example codes, see ConsentPolicyRuleCodes (example to `http://hl7.org/fhir/ValueSet/consent-policy|5.0.0` ) Regulatory policy examples
Type | CodeableConcept(SGHI CodeableConcept)
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
60. 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.
Short | Computable version of the backing policy
Control | 0..1
Type | BackboneElement
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
62. 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.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
64. 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.
Short | Additional 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-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()`)
66. 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).
Short | Extensions 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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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 Names | extensions, user content, modifiers
Invariants | ele-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()`)
68. Consent.policyBasis.reference
Definition | A Reference that identifies the policy the organization will enforce for this Consent.
Short | Reference backing policy resource
Comments | While any resource may be used, Consent, PlanDefinition and Contract would be most frequent
Control | 0..1
Type | Reference(SGHI Reference)(Resource)
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
70. Consent.policyBasis.url
Definition | A URL that links to a computable version of the policy the organization will enforce for this Consent.
Short | URL to a computable backing policy
Control | 0..1
Type | url
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
72. Consent.policyText
Definition | A Reference to the human readable policy explaining the basis for the Consent.
Short | Human Readable Policy
Control | 0..*
Type | Reference(SGHI Reference)(DocumentReference)
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
74. 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.
Short | Consent Verified by patient or family
Control | 1..*
Type | BackboneElement
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
76. 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.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
78. 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.
Short | Additional 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-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()`)
80. 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).
Short | Extensions 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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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 Names | extensions, user content, modifiers
Invariants | ele-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()`)
82. Consent.verification.verified
Definition | Has the instruction been verified.
Short | Has been verified
Control | 1..1
Type | boolean
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
84. Consent.verification.verificationType
Definition | Extensible list of verification type starting with verification and re-validation.
Short | Business 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.
Control | 0..1
Binding | For example codes, see ConsentVerificationCodes (example to `http://hl7.org/fhir/ValueSet/consent-verification|5.0.0` ) Types of Verification/Validation.
Type | CodeableConcept(SGHI CodeableConcept)
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
86. Consent.verification.verifiedBy
Definition | The person who conducted the verification/validation of the Grantor decision.
Short | Person conducting verification
Control | 1..1
Type | Reference(SGHI Reference)(SGHI Organization)
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
88. Consent.verification.verifiedWith
Definition | Who verified the instruction (Patient, Relative or other Authorized Person).
Short | Person who verified
Control | 1..1
Type | Reference(SGHI Reference)(SGHI Patient)
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
90. Consent.verification.verificationDate
Definition | Date(s) verification was collected.
Short | When consent verified
Comments | Allows for history of verification/validation.
Control | 1..1
Type | dateTime
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
92. Consent.decision
Definition | Action to take - permit or deny - as default.
Short | deny | permit
Control | 1..1
Binding | The 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.
Type | code
Is Modifier | true because Sets context for the values in .provision
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
94. Consent.provision
Definition | An exception to the base policy of this consent. An exception can be an addition or removal of access permissions.
Short | Constraints to the base Consent.policyRule/Consent.policy
Control | 0..*
Type | BackboneElement
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
96. 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.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
98. 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.
Short | Additional 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-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()`)
100. 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).
Short | Extensions 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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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 Names | extensions, user content, modifiers
Invariants | ele-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()`)
102. Consent.provision.period
Definition | Timeframe for this provision.
Short | Timeframe for this provision
Comments | This is the bound effective time of the consent and should be in the base provision in the Consent resource.
Control | 0..1
Type | Period
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
104. 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').
Short | Who|what controlled by this provision (or group, by role)
Control | 0..*
Type | BackboneElement
Is Modifier | false
Must Support | false
Summary | false
Meaning if Missing | There is no specific actor associated with the exception
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
106. 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.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
108. 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.
Short | Additional 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-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.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).
Short | Extensions 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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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 Names | extensions, user content, modifiers
Invariants | ele-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.actor.role
Definition | How the individual is involved in the resources content that is described in the exception.
Short | How the actor is involved
Control | 0..1
Binding | Unless 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.
Type | CodeableConcept(SGHI CodeableConcept)
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
114. 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').
Short | Resource for the actor (or group, by role)
Control | 0..1
Type | Reference(SGHI Reference)(SGHI Patient, SGHI Organization)
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
116. Consent.provision.action
Definition | Actions controlled by this provision.
Short | Actions 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'.
Control | 0..*
Binding | For example codes, see ConsentActionCodes (example to `http://hl7.org/fhir/ValueSet/consent-action|5.0.0` ) Detailed codes for the consent action.
Type | CodeableConcept(SGHI CodeableConcept)
Is Modifier | false
Must Support | false
Summary | true
Meaning if Missing | all actions
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
118. Consent.provision.securityLabel
Definition | A security label, comprised of 0..* security label fields (Privacy tags), which define which resources are controlled by this exception.
Short | Security Labels that define affected resources
Comments | If the consent specifies a security label of "R" then it applies to all resources that are 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.
Control | 0..*
Binding | For 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.
Type | Coding
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
120. 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.
Short | Context 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.
Control | 0..*
Binding | Unless 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.
Type | Coding
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
122. 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.
Short | e.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.
Control | 0..*
Binding | The 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.
Type | Coding
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
124. 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.
Short | e.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.
Control | 0..*
Binding | Unless 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.
Type | Coding
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
126. Consent.provision.code
Definition | If this code is found in an instance, then the provision applies.
Short | e.g. LOINC or SNOMED CT code, etc. in the content
Control | 0..*
Binding | The codes SHALL be taken from ConsentContentCodes (required to `http://hl7.org/fhir/ValueSet/consent-content-code` )
Type | CodeableConcept(SGHI CodeableConcept)
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
128. Consent.provision.dataPeriod
Definition | Clinical or Operational Relevant period of time that bounds the data controlled by this provision.
Short | Timeframe 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.
Control | 0..1
Type | Period
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
130. Consent.provision.data
Definition | The resources controlled by this provision if specific resources are referenced.
Short | Data controlled by this provision
Control | 0..*
Type | BackboneElement
Is Modifier | false
Must Support | false
Summary | true
Meaning if Missing | all data
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
132. 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.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
134. 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.
Short | Additional 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-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()`)
136. 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).
Short | Extensions 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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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 Names | extensions, user content, modifiers
Invariants | ele-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()`)
138. Consent.provision.data.meaning
Definition | How the resource reference is interpreted when testing consent restrictions.
Short | instance | related | dependents | authoredby
Control | 1..1
Binding | The 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.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
140. Consent.provision.data.reference
Definition | A reference to a specific resource that defines which resources are covered by this consent.
Short | The actual data reference
Control | 1..1
Type | Reference(SGHI Reference)(Resource)
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
142. Consent.provision.expression
Definition | A computable (FHIRPath or other) definition of what is controlled by this consent.
Short | A computable expression of the consent
Comments | Constraining the expression type for a specific implementation via profile is recommended
Control | 0..1
Type | Expression
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
144. Consent.provision.provision
Definition | Provisions which provide exceptions to the base provision or subprovisions.
Short | Nested Exception Provisions
Control | 0..*
Type | Seettp://hl7.org/fhir/StructureDefinition/Consent#Consent.provision
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)