SIL HIE 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/hie-fhir-ig-profile/ and changes regularly. See the Directory of published versions
Resource Profile: HIE Consent
| Official URL: https://nshr.dha.go.ke/fhir/StructureDefinition/consent | Version: 0.1.0 | |||
| Active as of 2026-10-20 | Computable Name: HIEConsent | |||
R4B Consent profiled for HIE workflows, emphasizing clear scope, category, subject, policy, and computable provisions.
Usages:
- This Profile is not used by any profiles in this Specification
You can also check for usages in the FHIR IG Statistics
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  Consent |
C | 0..* | Consent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time Constraints: ppc-1, ppc-2, ppc-3, ppc-4, ppc-5 |
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
  identifier |
1..* | Identifier | Identifier for this record (external references) | |
 use |
1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | |
| type |
C | 1..1 | HIECodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) Constraints: cc-text-or-code |
| system |
1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |
| value |
1..1 | string | The value that is unique Example General: 123456 | |
  assigner |
0..1 | HIEReference(HIE Organization) | Organization that issued id (may be just text) | |
| status |
1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent. | |
| scope |
C | 1..1 | HIECodeableConcept | Which of the four areas this resource covers (extensible) Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource. Constraints: cc-text-or-code |
| category |
C | 1..* | HIECodeableConcept | Classification of the consent statement - for indexing/retrieval Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement. Constraints: cc-text-or-code |
| patient |
1..1 | HIEReference(HIE Patient) | Who the consent applies to | |
| dateTime |
0..1 | dateTime | When this Consent was created or indexed | |
| performer |
1..* | HIEReference(HIE Patient | HIE Practitioner | PractitionerRole | RelatedPerson | HIE Organization) | Who is agreeing to the policy and rules | |
| organization |
1..* | HIEReference(HIE Organization) | Custodian of the consent | |
| policyRule |
C | 0..1 | HIECodeableConcept | Regulation that this consents to Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples. Constraints: cc-text-or-code |
 provision |
0..1 | BackboneElement | Constraints to the base Consent.policyRule | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| action |
C | 0..* | HIECodeableConcept | Actions controlled by this rule Binding: ConsentActionCodes (example): Detailed codes for the consent action. Constraints: cc-text-or-code |
| code |
C | 0..* | HIECodeableConcept | e.g. LOINC or SNOMED CT code, etc. in the content Binding: ConsentContentCodes (example): If this code is found in an instance, then the exception applies. Constraints: cc-text-or-code |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Consent.identifier.use | Base | required | IdentifierUse | 📦4.3.0 | FHIR Std. |
| Consent.identifier.type | Base | extensible | IdentifierType | 📦4.3.0 | FHIR Std. |
| Consent.status | Base | required | ConsentState | 📍4.3.0 | FHIR Std. |
| Consent.scope | Base | extensible | Consent Scope Codes | 📍4.3.0 | FHIR Std. |
| Consent.category | Base | extensible | Consent Category Codes | 📍4.3.0 | FHIR Std. |
| Consent.policyRule | Base | extensible | Consent PolicyRule Codes | 📍4.3.0 | FHIR Std. |
| Consent.provision.action | Base | example | Consent Action Codes | 📍4.3.0 | FHIR Std. |
| Consent.provision.code | Base | example | Consent Content Codes | 📍4.3.0 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| cc-text-or-code | warning | Consent.identifier.type, Consent.scope, Consent.category, Consent.policyRule, Consent.provision.action, Consent.provision.code | Text is optional, coding is required |
coding.exists()
|
| dom-2 | error | Consent | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Consent | 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.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Consent | 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 | error | Consent | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Consent | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| ppc-1 | error | Consent | Either a Policy or PolicyRule |
policy.exists() or policyRule.exists()
|
| ppc-2 | error | Consent | IF Scope=privacy, there must be a patient |
patient.exists() or scope.coding.where(system='something' and code='patient-privacy').exists().not()
|
| ppc-3 | error | Consent | IF Scope=research, there must be a patient |
patient.exists() or scope.coding.where(system='something' and code='research').exists().not()
|
| ppc-4 | error | Consent | IF Scope=adr, there must be a patient |
patient.exists() or scope.coding.where(system='something' and code='adr').exists().not()
|
| ppc-5 | error | Consent | IF Scope=treatment, there must be a patient |
patient.exists() or scope.coding.where(system='something' and code='treatment').exists().not()
|
This structure is derived from Consent
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Consent |
0..* | Consent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time | |
 identifier |
1..* | Identifier | Identifier for this record (external references) | |
| use |
1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | |
| type |
1..1 | HIECodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) | |
| system |
1..1 | uri | The namespace for the identifier value | |
| value |
1..1 | string | The value that is unique | |
| assigner |
0..1 | HIEReference(HIE Organization) | Organization that issued id (may be just text) | |
| status |
1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error | |
| scope |
1..1 | HIECodeableConcept | Which of the four areas this resource covers (extensible) | |
| category |
1..* | HIECodeableConcept | Classification of the consent statement - for indexing/retrieval | |
| patient |
1..1 | HIEReference(HIE Patient) | Who the consent applies to | |
| dateTime |
0..1 | dateTime | When this Consent was created or indexed | |
| performer |
1..* | HIEReference(HIE Patient | HIE Practitioner | PractitionerRole | RelatedPerson | HIE Organization) | Who is agreeing to the policy and rules | |
| organization |
1..* | HIEReference(HIE Organization) | Custodian of the consent | |
| policyRule |
0..1 | HIECodeableConcept | Regulation that this consents to | |
| verification |
||||
| verifiedWith |
0..1 | Reference(HIE Patient | RelatedPerson) | Person who verified | |
| provision |
0..1 | BackboneElement | Constraints to the base Consent.policyRule | |
| actor |
||||
| role |
1..1 | HIECodeableConcept | How the actor is involved | |
| reference |
1..1 | HIEReference(HIE Patient | HIE Practitioner | PractitionerRole | RelatedPerson | Organization | CareTeam | Device) | Resource for the actor (or group, by role) | |
| action |
0..* | HIECodeableConcept | Actions controlled by this rule | |
| code |
0..* | HIECodeableConcept | e.g. LOINC or SNOMED CT code, etc. in the content | |
| data |
||||
| reference |
1..1 | HIEReference(Resource) | The actual data reference | |
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Status | Usage | ValueSet | Version | Source |
| Consent.identifier.use | Base | required | IdentifierUse | 📦4.3.0 | FHIR Std. |
| Consent.identifier.type | Base | extensible | IdentifierType | 📦4.3.0 | FHIR Std. |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Consent |
C | 0..* | Consent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time Constraints: ppc-1, ppc-2, ppc-3, ppc-4, ppc-5 | ||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources Constraints: dom-r4b | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
1..* | Identifier | Identifier for this record (external references) | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | |||||
| type |
C | 1..1 | HIECodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) Constraints: cc-text-or-code | ||||
| system |
1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |||||
| value |
1..1 | string | The value that is unique Example General: 123456 | |||||
| period |
0..1 | Period | Time period when id is/was valid for use | |||||
| assigner |
0..1 | HIEReference(HIE Organization) | Organization that issued id (may be just text) | |||||
| status |
1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent. | |||||
| scope |
C | 1..1 | HIECodeableConcept | Which of the four areas this resource covers (extensible) Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource. Constraints: cc-text-or-code | ||||
| category |
C | 1..* | HIECodeableConcept | Classification of the consent statement - for indexing/retrieval Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement. Constraints: cc-text-or-code | ||||
| patient |
1..1 | HIEReference(HIE Patient) | Who the consent applies to | |||||
| dateTime |
0..1 | dateTime | When this Consent was created or indexed | |||||
| performer |
1..* | HIEReference(HIE Patient | HIE Practitioner | PractitionerRole | RelatedPerson | HIE Organization) | Who is agreeing to the policy and rules | |||||
| organization |
1..* | HIEReference(HIE Organization) | Custodian of the consent | |||||
 source[x] |
0..1 | Source from which this consent is taken | ||||||
| sourceAttachment |
Attachment | |||||||
| sourceReference |
Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) | |||||||
| policy |
0..* | BackboneElement | Policies covered by this consent | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| authority |
C | 0..1 | uri | Enforcement source for policy | ||||
| uri |
C | 0..1 | uri | Specific policy covered by this consent | ||||
| policyRule |
C | 0..1 | HIECodeableConcept | Regulation that this consents to Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples. Constraints: cc-text-or-code | ||||
| verification |
0..* | BackboneElement | Consent Verified by patient or family | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| verified |
1..1 | boolean | Has been verified | |||||
| verifiedWith |
0..1 | Reference(HIE Patient | RelatedPerson) | Person who verified | |||||
| verificationDate |
0..1 | dateTime | When consent verified | |||||
| provision |
0..1 | BackboneElement | Constraints to the base Consent.policyRule | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| type |
0..1 | code | deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent. | |||||
| period |
0..1 | Period | Timeframe for this rule | |||||
| actor |
0..* | BackboneElement | Who|what controlled by this rule (or group, by role) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| role |
C | 1..1 | HIECodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. Constraints: cc-text-or-code | ||||
| reference |
1..1 | HIEReference(HIE Patient | HIE Practitioner | PractitionerRole | RelatedPerson | Organization | CareTeam | Device) | Resource for the actor (or group, by role) | |||||
| action |
C | 0..* | HIECodeableConcept | Actions controlled by this rule Binding: ConsentActionCodes (example): Detailed codes for the consent action. Constraints: cc-text-or-code | ||||
| securityLabel |
0..* | Coding | Security Labels that define affected resources Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |||||
| purpose |
0..* | Coding | Context of activities covered by this rule Binding: PurposeOfUse (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels. | |||||
| class |
0..* | Coding | e.g. Resource Type, Profile, CDA, etc. Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers. | |||||
| code |
C | 0..* | HIECodeableConcept | e.g. LOINC or SNOMED CT code, etc. in the content Binding: ConsentContentCodes (example): If this code is found in an instance, then the exception applies. Constraints: cc-text-or-code | ||||
| dataPeriod |
0..1 | Period | Timeframe for data controlled by this rule | |||||
| data |
0..* | BackboneElement | Data controlled by this rule | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| meaning |
1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. | |||||
| reference |
1..1 | HIEReference(Resource) | The actual data reference | |||||
| provision |
0..* | See provision (Consent) | Nested Exception Rules | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Consent.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| Consent.identifier.use | Base | required | IdentifierUse | 📦4.3.0 | FHIR Std. |
| Consent.identifier.type | Base | extensible | IdentifierType | 📦4.3.0 | FHIR Std. |
| Consent.status | Base | required | ConsentState | 📍4.3.0 | FHIR Std. |
| Consent.scope | Base | extensible | Consent Scope Codes | 📍4.3.0 | FHIR Std. |
| Consent.category | Base | extensible | Consent Category Codes | 📍4.3.0 | FHIR Std. |
| Consent.policyRule | Base | extensible | Consent PolicyRule Codes | 📍4.3.0 | FHIR Std. |
| Consent.provision.type | Base | required | ConsentProvisionType | 📍4.3.0 | FHIR Std. |
| Consent.provision.actor.role | Base | extensible | SecurityRoleType | 📍4.3.0 | FHIR Std. |
| Consent.provision.action | Base | example | Consent Action Codes | 📍4.3.0 | FHIR Std. |
| Consent.provision.securityLabel | Base | extensible | SecurityLabels | 📍4.3.0 | FHIR Std. |
| Consent.provision.purpose | Base | extensible | PurposeOfUse | 📦3.1.0 | THO v7.4 |
| Consent.provision.class | Base | extensible | Consent Content Class | 📍4.3.0 | FHIR Std. |
| Consent.provision.code | Base | example | Consent Content Codes | 📍4.3.0 | FHIR Std. |
| Consent.provision.data.meaning | Base | required | ConsentDataMeaning | 📍4.3.0 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| cc-text-or-code | warning | Consent.identifier.type, Consent.scope, Consent.category, Consent.policyRule, Consent.provision.actor.role, Consent.provision.action, Consent.provision.code | Text is optional, coding is required |
coding.exists()
|
| dom-2 | error | Consent | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Consent | 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.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Consent | 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 | error | Consent | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Consent | A resource should have narrative for robust management |
text.`div`.exists()
|
| dom-r4b | warning | Consent.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems |
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| ppc-1 | error | Consent | Either a Policy or PolicyRule |
policy.exists() or policyRule.exists()
|
| ppc-2 | error | Consent | IF Scope=privacy, there must be a patient |
patient.exists() or scope.coding.where(system='something' and code='patient-privacy').exists().not()
|
| ppc-3 | error | Consent | IF Scope=research, there must be a patient |
patient.exists() or scope.coding.where(system='something' and code='research').exists().not()
|
| ppc-4 | error | Consent | IF Scope=adr, there must be a patient |
patient.exists() or scope.coding.where(system='something' and code='adr').exists().not()
|
| ppc-5 | error | Consent | IF Scope=treatment, there must be a patient |
patient.exists() or scope.coding.where(system='something' and code='treatment').exists().not()
|
This structure is derived from Consent
Summary
Mandatory: 8 elements
Must-Support: 11 elements
Structures
This structure refers to these other structures:
- HIE CodeableConcept (https://nshr.dha.go.ke/fhir/StructureDefinition/codeable-concept)
- HIE Reference (https://nshr.dha.go.ke/fhir/StructureDefinition/reference)
- HIE Organization (https://nshr.dha.go.ke/fhir/StructureDefinition/organization)
- HIE Patient (https://nshr.dha.go.ke/fhir/StructureDefinition/patient)
- HIE Practitioner (https://nshr.dha.go.ke/fhir/StructureDefinition/practitioner)
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Consent |
C | 0..* | Consent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time Constraints: ppc-1, ppc-2, ppc-3, ppc-4, ppc-5 |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| identifier |
1..* | Identifier | Identifier for this record (external references) | |
| use |
1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | |
| type |
C | 1..1 | HIECodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) Constraints: cc-text-or-code |
| system |
1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |
| value |
1..1 | string | The value that is unique Example General: 123456 | |
| assigner |
0..1 | HIEReference(HIE Organization) | Organization that issued id (may be just text) | |
| status |
1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent. | |
| scope |
C | 1..1 | HIECodeableConcept | Which of the four areas this resource covers (extensible) Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource. Constraints: cc-text-or-code |
| category |
C | 1..* | HIECodeableConcept | Classification of the consent statement - for indexing/retrieval Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement. Constraints: cc-text-or-code |
| patient |
1..1 | HIEReference(HIE Patient) | Who the consent applies to | |
| dateTime |
0..1 | dateTime | When this Consent was created or indexed | |
| performer |
1..* | HIEReference(HIE Patient | HIE Practitioner | PractitionerRole | RelatedPerson | HIE Organization) | Who is agreeing to the policy and rules | |
| organization |
1..* | HIEReference(HIE Organization) | Custodian of the consent | |
| policyRule |
C | 0..1 | HIECodeableConcept | Regulation that this consents to Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples. Constraints: cc-text-or-code |
| provision |
0..1 | BackboneElement | Constraints to the base Consent.policyRule | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| action |
C | 0..* | HIECodeableConcept | Actions controlled by this rule Binding: ConsentActionCodes (example): Detailed codes for the consent action. Constraints: cc-text-or-code |
| code |
C | 0..* | HIECodeableConcept | e.g. LOINC or SNOMED CT code, etc. in the content Binding: ConsentContentCodes (example): If this code is found in an instance, then the exception applies. Constraints: cc-text-or-code |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Consent.identifier.use | Base | required | IdentifierUse | 📦4.3.0 | FHIR Std. |
| Consent.identifier.type | Base | extensible | IdentifierType | 📦4.3.0 | FHIR Std. |
| Consent.status | Base | required | ConsentState | 📍4.3.0 | FHIR Std. |
| Consent.scope | Base | extensible | Consent Scope Codes | 📍4.3.0 | FHIR Std. |
| Consent.category | Base | extensible | Consent Category Codes | 📍4.3.0 | FHIR Std. |
| Consent.policyRule | Base | extensible | Consent PolicyRule Codes | 📍4.3.0 | FHIR Std. |
| Consent.provision.action | Base | example | Consent Action Codes | 📍4.3.0 | FHIR Std. |
| Consent.provision.code | Base | example | Consent Content Codes | 📍4.3.0 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| cc-text-or-code | warning | Consent.identifier.type, Consent.scope, Consent.category, Consent.policyRule, Consent.provision.action, Consent.provision.code | Text is optional, coding is required |
coding.exists()
|
| dom-2 | error | Consent | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Consent | 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.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Consent | 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 | error | Consent | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Consent | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| ppc-1 | error | Consent | Either a Policy or PolicyRule |
policy.exists() or policyRule.exists()
|
| ppc-2 | error | Consent | IF Scope=privacy, there must be a patient |
patient.exists() or scope.coding.where(system='something' and code='patient-privacy').exists().not()
|
| ppc-3 | error | Consent | IF Scope=research, there must be a patient |
patient.exists() or scope.coding.where(system='something' and code='research').exists().not()
|
| ppc-4 | error | Consent | IF Scope=adr, there must be a patient |
patient.exists() or scope.coding.where(system='something' and code='adr').exists().not()
|
| ppc-5 | error | Consent | IF Scope=treatment, there must be a patient |
patient.exists() or scope.coding.where(system='something' and code='treatment').exists().not()
|
Differential View
This structure is derived from Consent
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Consent |
0..* | Consent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time | |
| identifier |
1..* | Identifier | Identifier for this record (external references) | |
| use |
1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | |
| type |
1..1 | HIECodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) | |
| system |
1..1 | uri | The namespace for the identifier value | |
| value |
1..1 | string | The value that is unique | |
| assigner |
0..1 | HIEReference(HIE Organization) | Organization that issued id (may be just text) | |
| status |
1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error | |
| scope |
1..1 | HIECodeableConcept | Which of the four areas this resource covers (extensible) | |
| category |
1..* | HIECodeableConcept | Classification of the consent statement - for indexing/retrieval | |
| patient |
1..1 | HIEReference(HIE Patient) | Who the consent applies to | |
| dateTime |
0..1 | dateTime | When this Consent was created or indexed | |
| performer |
1..* | HIEReference(HIE Patient | HIE Practitioner | PractitionerRole | RelatedPerson | HIE Organization) | Who is agreeing to the policy and rules | |
| organization |
1..* | HIEReference(HIE Organization) | Custodian of the consent | |
| policyRule |
0..1 | HIECodeableConcept | Regulation that this consents to | |
| verification |
||||
| verifiedWith |
0..1 | Reference(HIE Patient | RelatedPerson) | Person who verified | |
| provision |
0..1 | BackboneElement | Constraints to the base Consent.policyRule | |
| actor |
||||
| role |
1..1 | HIECodeableConcept | How the actor is involved | |
| reference |
1..1 | HIEReference(HIE Patient | HIE Practitioner | PractitionerRole | RelatedPerson | Organization | CareTeam | Device) | Resource for the actor (or group, by role) | |
| action |
0..* | HIECodeableConcept | Actions controlled by this rule | |
| code |
0..* | HIECodeableConcept | e.g. LOINC or SNOMED CT code, etc. in the content | |
| data |
||||
| reference |
1..1 | HIEReference(Resource) | The actual data reference | |
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Status | Usage | ValueSet | Version | Source |
| Consent.identifier.use | Base | required | IdentifierUse | 📦4.3.0 | FHIR Std. |
| Consent.identifier.type | Base | extensible | IdentifierType | 📦4.3.0 | FHIR Std. |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Consent |
C | 0..* | Consent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time Constraints: ppc-1, ppc-2, ppc-3, ppc-4, ppc-5 | ||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources Constraints: dom-r4b | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
1..* | Identifier | Identifier for this record (external references) | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | |||||
| type |
C | 1..1 | HIECodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) Constraints: cc-text-or-code | ||||
| system |
1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |||||
| value |
1..1 | string | The value that is unique Example General: 123456 | |||||
| period |
0..1 | Period | Time period when id is/was valid for use | |||||
| assigner |
0..1 | HIEReference(HIE Organization) | Organization that issued id (may be just text) | |||||
| status |
1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent. | |||||
| scope |
C | 1..1 | HIECodeableConcept | Which of the four areas this resource covers (extensible) Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource. Constraints: cc-text-or-code | ||||
| category |
C | 1..* | HIECodeableConcept | Classification of the consent statement - for indexing/retrieval Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement. Constraints: cc-text-or-code | ||||
| patient |
1..1 | HIEReference(HIE Patient) | Who the consent applies to | |||||
| dateTime |
0..1 | dateTime | When this Consent was created or indexed | |||||
| performer |
1..* | HIEReference(HIE Patient | HIE Practitioner | PractitionerRole | RelatedPerson | HIE Organization) | Who is agreeing to the policy and rules | |||||
| organization |
1..* | HIEReference(HIE Organization) | Custodian of the consent | |||||
| source[x] |
0..1 | Source from which this consent is taken | ||||||
| sourceAttachment |
Attachment | |||||||
| sourceReference |
Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) | |||||||
| policy |
0..* | BackboneElement | Policies covered by this consent | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| authority |
C | 0..1 | uri | Enforcement source for policy | ||||
| uri |
C | 0..1 | uri | Specific policy covered by this consent | ||||
| policyRule |
C | 0..1 | HIECodeableConcept | Regulation that this consents to Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples. Constraints: cc-text-or-code | ||||
| verification |
0..* | BackboneElement | Consent Verified by patient or family | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| verified |
1..1 | boolean | Has been verified | |||||
| verifiedWith |
0..1 | Reference(HIE Patient | RelatedPerson) | Person who verified | |||||
| verificationDate |
0..1 | dateTime | When consent verified | |||||
| provision |
0..1 | BackboneElement | Constraints to the base Consent.policyRule | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| type |
0..1 | code | deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent. | |||||
| period |
0..1 | Period | Timeframe for this rule | |||||
| actor |
0..* | BackboneElement | Who|what controlled by this rule (or group, by role) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| role |
C | 1..1 | HIECodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. Constraints: cc-text-or-code | ||||
| reference |
1..1 | HIEReference(HIE Patient | HIE Practitioner | PractitionerRole | RelatedPerson | Organization | CareTeam | Device) | Resource for the actor (or group, by role) | |||||
| action |
C | 0..* | HIECodeableConcept | Actions controlled by this rule Binding: ConsentActionCodes (example): Detailed codes for the consent action. Constraints: cc-text-or-code | ||||
| securityLabel |
0..* | Coding | Security Labels that define affected resources Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |||||
| purpose |
0..* | Coding | Context of activities covered by this rule Binding: PurposeOfUse (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels. | |||||
| class |
0..* | Coding | e.g. Resource Type, Profile, CDA, etc. Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers. | |||||
| code |
C | 0..* | HIECodeableConcept | e.g. LOINC or SNOMED CT code, etc. in the content Binding: ConsentContentCodes (example): If this code is found in an instance, then the exception applies. Constraints: cc-text-or-code | ||||
| dataPeriod |
0..1 | Period | Timeframe for data controlled by this rule | |||||
| data |
0..* | BackboneElement | Data controlled by this rule | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| meaning |
1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. | |||||
| reference |
1..1 | HIEReference(Resource) | The actual data reference | |||||
| provision |
0..* | See provision (Consent) | Nested Exception Rules | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Consent.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| Consent.identifier.use | Base | required | IdentifierUse | 📦4.3.0 | FHIR Std. |
| Consent.identifier.type | Base | extensible | IdentifierType | 📦4.3.0 | FHIR Std. |
| Consent.status | Base | required | ConsentState | 📍4.3.0 | FHIR Std. |
| Consent.scope | Base | extensible | Consent Scope Codes | 📍4.3.0 | FHIR Std. |
| Consent.category | Base | extensible | Consent Category Codes | 📍4.3.0 | FHIR Std. |
| Consent.policyRule | Base | extensible | Consent PolicyRule Codes | 📍4.3.0 | FHIR Std. |
| Consent.provision.type | Base | required | ConsentProvisionType | 📍4.3.0 | FHIR Std. |
| Consent.provision.actor.role | Base | extensible | SecurityRoleType | 📍4.3.0 | FHIR Std. |
| Consent.provision.action | Base | example | Consent Action Codes | 📍4.3.0 | FHIR Std. |
| Consent.provision.securityLabel | Base | extensible | SecurityLabels | 📍4.3.0 | FHIR Std. |
| Consent.provision.purpose | Base | extensible | PurposeOfUse | 📦3.1.0 | THO v7.4 |
| Consent.provision.class | Base | extensible | Consent Content Class | 📍4.3.0 | FHIR Std. |
| Consent.provision.code | Base | example | Consent Content Codes | 📍4.3.0 | FHIR Std. |
| Consent.provision.data.meaning | Base | required | ConsentDataMeaning | 📍4.3.0 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| cc-text-or-code | warning | Consent.identifier.type, Consent.scope, Consent.category, Consent.policyRule, Consent.provision.actor.role, Consent.provision.action, Consent.provision.code | Text is optional, coding is required |
coding.exists()
|
| dom-2 | error | Consent | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Consent | 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.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Consent | 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 | error | Consent | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Consent | A resource should have narrative for robust management |
text.`div`.exists()
|
| dom-r4b | warning | Consent.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems |
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| ppc-1 | error | Consent | Either a Policy or PolicyRule |
policy.exists() or policyRule.exists()
|
| ppc-2 | error | Consent | IF Scope=privacy, there must be a patient |
patient.exists() or scope.coding.where(system='something' and code='patient-privacy').exists().not()
|
| ppc-3 | error | Consent | IF Scope=research, there must be a patient |
patient.exists() or scope.coding.where(system='something' and code='research').exists().not()
|
| ppc-4 | error | Consent | IF Scope=adr, there must be a patient |
patient.exists() or scope.coding.where(system='something' and code='adr').exists().not()
|
| ppc-5 | error | Consent | IF Scope=treatment, there must be a patient |
patient.exists() or scope.coding.where(system='something' and code='treatment').exists().not()
|
This structure is derived from Consent
Summary
Mandatory: 8 elements
Must-Support: 11 elements
Structures
This structure refers to these other structures:
- HIE CodeableConcept (https://nshr.dha.go.ke/fhir/StructureDefinition/codeable-concept)
- HIE Reference (https://nshr.dha.go.ke/fhir/StructureDefinition/reference)
- HIE Organization (https://nshr.dha.go.ke/fhir/StructureDefinition/organization)
- HIE Patient (https://nshr.dha.go.ke/fhir/StructureDefinition/patient)
- HIE Practitioner (https://nshr.dha.go.ke/fhir/StructureDefinition/practitioner)
Other representations of profile: CSV, Excel, Schematron