Healthy Route Implementation Guide, published by Savannah Informatics. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/savannahghi/healthy-route-ig/ and changes regularly. See the Directory of published versions
Resource Profile: Healthy Route Consent
| Official URL: https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-consent | Version: 0.1.0 | |||
| Draft as of 2026-10-11 | Computable Name: HRConsent | |||
The record that a participant granted or refused one permission, and the index to the page they signed.
Establishes the lawful basis for every subsequent resource held about the participant. A screening encounter, a specimen or a retinal image that cannot be traced to an active consent for the permission it relies on is a finding at audit, and this resource is what makes that traceable rather than a matter of correspondence.
Usages:
- Refer to this Profile: Healthy Route Study Participation
- Examples for this Profile: Consent/ExampleConsentParticipation
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 |
0..* | Consent | 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 | |
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| contained |
0..* | Resource | Contained, inline Resources | |
  Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
   extension:tenant |
1..1 | Identifier | Owning site tenant URL: https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-tenant | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| status |
1..1 | code | draft | active | inactive | not-done | entered-in-error | unknown Binding: ConsentState (required): Indicates the state of the consent. | |
 Slices for category |
1..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Slice: Unordered, Open by value:coding.system Binding: ConsentCategoryCodes (example): A classification of the type of consents found in a consent statement. Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
 category:permission |
1..1 | CodeableConcept | Which permission this resource records Binding: Consent Permission Value Set (required) | |
   coding |
1..1 | Coding | Code defined by a terminology system | |
 system |
1..1 | uri | Identity of the terminology system Required Pattern: https://fhir.savannahghi.org/ig/healthy-route/CodeSystem/hr-consent-permission | |
 subject |
1..1 | Reference(Healthy Route Patient) | Who the consent applies to | |
| date |
1..1 | date | Date the participant signed | |
| period |
0..1 | Period | Period over which the permission applies | |
| grantor |
1..1 | Reference(Healthy Route Patient | RelatedPerson) | Who is granting rights according to the policy and rules | |
| grantee |
1..* | Reference(Healthy Route Organization) | Party the permission is granted to | |
| controller |
0..* | Reference(Healthy Route Organization) | Data controller | |
| sourceReference |
0..1 | Reference(Healthy Route Consent Evidence) | The photographed signed page | |
| regulatoryBasis |
0..* | CodeableConcept | Regulatory framework the consent was taken under Binding: ConsentPolicyRuleCodes (example): Regulatory policy examples | |
| policyBasis |
1..1 | BackboneElement | Computable version of the backing policy | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| url |
1..1 | url | Versioned identifier of the approved information sheet | |
| policyText |
0..* | Reference(Healthy Route Document) | The approved blank information sheet and consent form | |
| verification |
1..1 | BackboneElement | Consent Verified by patient or family | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| verified |
1..1 | boolean | Has been verified | |
| verifiedBy |
1..1 | Reference(Healthy Route Practitioner) | Person who took consent | |
| verificationDate |
1..1 | dateTime | When consent verified | |
| decision |
1..1 | code | permit or deny Binding: ConsentProvisionType (required): Sets the base decision for Consent to be either permit or deny, with provisions assumed to be a negation of the previous level. | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Consent.status | Base | required | Consent State | 📍5.0.0 | FHIR Std. |
| Consent.category | Base | example | Consent Category Codes | 📍5.0.0 | FHIR Std. |
| Consent.category:permission | Base | required | Consent Permission Value Set | 📦0.1.0 | This IG |
| Consent.regulatoryBasis | Base | example | Consent PolicyRule Codes | 📍5.0.0 | FHIR Std. |
| Consent.decision | Base | required | Consent Provision Type | 📍5.0.0 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from Consent
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Consent |
0..* | Consent | 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 | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:tenant |
1..1 | Identifier | Owning site tenant URL: https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-tenant | |
 status |
1..1 | code | draft | active | inactive | not-done | entered-in-error | unknown | |
| Slices for category |
1..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Slice: Unordered, Open by value:coding.system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| category:permission |
1..1 | CodeableConcept | Which permission this resource records Binding: Consent Permission Value Set (required) | |
| coding |
1..1 | Coding | Code defined by a terminology system | |
| system |
1..1 | uri | Identity of the terminology system Required Pattern: https://fhir.savannahghi.org/ig/healthy-route/CodeSystem/hr-consent-permission | |
| subject |
1..1 | Reference(Healthy Route Patient) | Who the consent applies to | |
| date |
1..1 | date | Date the participant signed | |
| period |
0..1 | Period | Period over which the permission applies | |
| grantor |
1..1 | Reference(Healthy Route Patient | RelatedPerson) | Who is granting rights according to the policy and rules | |
| grantee |
1..* | Reference(Healthy Route Organization) | Party the permission is granted to | |
| controller |
0..* | Reference(Healthy Route Organization) | Data controller | |
| sourceReference |
0..1 | Reference(Healthy Route Consent Evidence) | The photographed signed page | |
| regulatoryBasis |
0..* | CodeableConcept | Regulatory framework the consent was taken under | |
| policyBasis |
1..1 | BackboneElement | Computable version of the backing policy | |
| url |
1..1 | url | Versioned identifier of the approved information sheet | |
| policyText |
0..* | Reference(Healthy Route Document) | The approved blank information sheet and consent form | |
| verification |
1..1 | BackboneElement | Consent Verified by patient or family | |
| verified |
1..1 | boolean | Has been verified | |
| verifiedBy |
1..1 | Reference(Healthy Route Practitioner) | Person who took consent | |
| verificationDate |
1..1 | dateTime | When consent verified | |
| decision |
1..1 | code | permit or deny | |
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Status | Usage | ValueSet | Version | Source |
| Consent.category:permission | Base | required | Consent Permission Value Set | 📦0.1.0 | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Consent |
0..* | Consent | 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 | |||||
| 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: AllLanguages (required): IETF language tag for a human language
| |||||
| 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 | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| extension:tenant |
1..1 | Identifier | Owning site tenant URL: https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-tenant | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
0..* | Identifier | Identifier for this record (external references) | |||||
| status |
1..1 | code | draft | active | inactive | not-done | entered-in-error | unknown Binding: ConsentState (required): Indicates the state of the consent. | |||||
| Slices for category |
1..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Slice: Unordered, Open by value:coding.system Binding: ConsentCategoryCodes (example): A classification of the type of consents found in a consent statement. Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| category:permission |
1..1 | CodeableConcept | Which permission this resource records Binding: Consent Permission Value Set (required) | |||||
 id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
 coding |
1..1 | Coding | Code defined by a terminology system | |||||
 id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Identity of the terminology system Required Pattern: https://fhir.savannahghi.org/ig/healthy-route/CodeSystem/hr-consent-permission | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
C | 0..1 | code | Symbol in syntax defined by the system | ||||
| display |
C | 0..1 | string | Representation defined by the system | ||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
 text |
0..1 | string | Plain text representation of the concept | |||||
| subject |
1..1 | Reference(Healthy Route Patient) | Who the consent applies to | |||||
| date |
1..1 | date | Date the participant signed | |||||
| period |
0..1 | Period | Period over which the permission applies | |||||
| grantor |
1..1 | Reference(Healthy Route Patient | RelatedPerson) | Who is granting rights according to the policy and rules | |||||
| grantee |
1..* | Reference(Healthy Route Organization) | Party the permission is granted to | |||||
| manager |
0..* | Reference(HealthcareService | Organization | Patient | Practitioner) | Consent workflow management | |||||
| controller |
0..* | Reference(Healthy Route Organization) | Data controller | |||||
| sourceAttachment |
0..* | Attachment | Source from which this consent is taken | |||||
| sourceReference |
0..1 | Reference(Healthy Route Consent Evidence) | The photographed signed page | |||||
| regulatoryBasis |
0..* | CodeableConcept | Regulatory framework the consent was taken under Binding: ConsentPolicyRuleCodes (example): Regulatory policy examples | |||||
| policyBasis |
1..1 | BackboneElement | Computable version of the backing policy | |||||
| 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 | |||||
| reference |
0..1 | Reference(Resource) | Reference backing policy resource | |||||
| url |
1..1 | url | Versioned identifier of the approved information sheet | |||||
| policyText |
0..* | Reference(Healthy Route Document) | The approved blank information sheet and consent form | |||||
| verification |
1..1 | 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 | |||||
| verificationType |
0..1 | CodeableConcept | Business case of verification Binding: ConsentVerificationCodes (example): Types of Verification/Validation. | |||||
| verifiedBy |
1..1 | Reference(Healthy Route Practitioner) | Person who took consent | |||||
| verifiedWith |
0..1 | Reference(Patient | RelatedPerson) | Person who verified | |||||
| verificationDate |
1..1 | dateTime | When consent verified | |||||
| decision |
1..1 | code | permit or deny Binding: ConsentProvisionType (required): Sets the base decision for Consent to be either permit or deny, with provisions assumed to be a negation of the previous level. | |||||
 provision |
0..* | BackboneElement | Constraints to the base Consent.policyRule/Consent.policy | |||||
| 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 | |||||
| period |
0..1 | Period | Timeframe for this provision | |||||
| actor |
0..* | BackboneElement | Who|what controlled by this provision (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 |
0..1 | CodeableConcept | How the actor is involved Binding: ParticipationRoleType (extensible): How an actor is involved in the consent considerations. | |||||
| reference |
0..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Resource for the actor (or group, by role) | |||||
| action |
0..* | CodeableConcept | Actions controlled by this provision Binding: ConsentActionCodes (example): Detailed codes for the consent action. | |||||
| securityLabel |
0..* | Coding | Security Labels that define affected resources Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System. | |||||
| purpose |
0..* | Coding | Context of activities covered by this provision 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. | |||||
| documentType |
0..* | Coding | e.g. Resource Type, Profile, CDA, etc Binding: ConsentContentClass (preferred): The document type a consent provision covers. | |||||
| resourceType |
0..* | Coding | e.g. Resource Type, Profile, etc Binding: ResourceType (extensible): The resource types a consent provision covers. | |||||
| code |
0..* | CodeableConcept | 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. | |||||
| dataPeriod |
0..1 | Period | Timeframe for data controlled by this provision | |||||
| data |
0..* | BackboneElement | Data controlled by this provision | |||||
| 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 | Reference(Resource) | The actual data reference | |||||
| expression |
0..1 | Expression | A computable expression of the consent | |||||
| provision |
0..* | See provision (Consent) | Nested Exception Provisions | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Consent.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| Consent.status | Base | required | Consent State | 📍5.0.0 | FHIR Std. |
| Consent.category | Base | example | Consent Category Codes | 📍5.0.0 | FHIR Std. |
| Consent.category:permission | Base | required | Consent Permission Value Set | 📦0.1.0 | This IG |
| Consent.regulatoryBasis | Base | example | Consent PolicyRule Codes | 📍5.0.0 | FHIR Std. |
| Consent.verification.verificationType | Base | example | Consent Vefication Codes | 📍5.0.0 | FHIR Std. |
| Consent.decision | Base | required | Consent Provision Type | 📍5.0.0 | FHIR Std. |
| Consent.provision.actor.role | Base | extensible | Participation Role Type | 📍5.0.0 | FHIR Std. |
| Consent.provision.action | Base | example | Consent Action Codes | 📍5.0.0 | FHIR Std. |
| Consent.provision.securityLabel | Base | example | Example set of Security Labels | 📍5.0.0 | FHIR Std. |
| Consent.provision.purpose | Base | extensible | PurposeOfUse | 📦3.1.0 | THO v7.4 |
| Consent.provision.documentType | Base | preferred | Consent Content Class | 📍5.0.0 | FHIR Std. |
| Consent.provision.resourceType | Base | extensible | Resource Types | 📍5.0.0 | FHIR Std. |
| Consent.provision.code | Base | example | Consent Content Codes | 📍5.0.0 | FHIR Std. |
| Consent.provision.data.meaning | Base | required | Consent Data Meaning | 📍5.0.0 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from Consent
Summary
Mandatory: 16 elements
Must-Support: 22 elements
Structures
This structure refers to these other structures:
- Healthy Route Patient (https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-patient)
- Healthy Route Organization (https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-organization)
- Healthy Route Consent Evidence (https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-consent-evidence)
- Healthy Route Document (https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-document-reference)
- Healthy Route Practitioner (https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-practitioner)
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
- The element 1 is sliced based on the value of Consent.category
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Consent |
0..* | Consent | 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 | |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| contained |
0..* | Resource | Contained, inline Resources | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:tenant |
1..1 | Identifier | Owning site tenant URL: https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-tenant | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| status |
1..1 | code | draft | active | inactive | not-done | entered-in-error | unknown Binding: ConsentState (required): Indicates the state of the consent. | |
| Slices for category |
1..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Slice: Unordered, Open by value:coding.system Binding: ConsentCategoryCodes (example): A classification of the type of consents found in a consent statement. Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| category:permission |
1..1 | CodeableConcept | Which permission this resource records Binding: Consent Permission Value Set (required) | |
| coding |
1..1 | Coding | Code defined by a terminology system | |
| system |
1..1 | uri | Identity of the terminology system Required Pattern: https://fhir.savannahghi.org/ig/healthy-route/CodeSystem/hr-consent-permission | |
| subject |
1..1 | Reference(Healthy Route Patient) | Who the consent applies to | |
| date |
1..1 | date | Date the participant signed | |
| period |
0..1 | Period | Period over which the permission applies | |
| grantor |
1..1 | Reference(Healthy Route Patient | RelatedPerson) | Who is granting rights according to the policy and rules | |
| grantee |
1..* | Reference(Healthy Route Organization) | Party the permission is granted to | |
| controller |
0..* | Reference(Healthy Route Organization) | Data controller | |
| sourceReference |
0..1 | Reference(Healthy Route Consent Evidence) | The photographed signed page | |
| regulatoryBasis |
0..* | CodeableConcept | Regulatory framework the consent was taken under Binding: ConsentPolicyRuleCodes (example): Regulatory policy examples | |
| policyBasis |
1..1 | BackboneElement | Computable version of the backing policy | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| url |
1..1 | url | Versioned identifier of the approved information sheet | |
| policyText |
0..* | Reference(Healthy Route Document) | The approved blank information sheet and consent form | |
| verification |
1..1 | BackboneElement | Consent Verified by patient or family | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| verified |
1..1 | boolean | Has been verified | |
| verifiedBy |
1..1 | Reference(Healthy Route Practitioner) | Person who took consent | |
| verificationDate |
1..1 | dateTime | When consent verified | |
| decision |
1..1 | code | permit or deny Binding: ConsentProvisionType (required): Sets the base decision for Consent to be either permit or deny, with provisions assumed to be a negation of the previous level. | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Consent.status | Base | required | Consent State | 📍5.0.0 | FHIR Std. |
| Consent.category | Base | example | Consent Category Codes | 📍5.0.0 | FHIR Std. |
| Consent.category:permission | Base | required | Consent Permission Value Set | 📦0.1.0 | This IG |
| Consent.regulatoryBasis | Base | example | Consent PolicyRule Codes | 📍5.0.0 | FHIR Std. |
| Consent.decision | Base | required | Consent Provision Type | 📍5.0.0 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
Differential View
This structure is derived from Consent
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Consent |
0..* | Consent | 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 | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:tenant |
1..1 | Identifier | Owning site tenant URL: https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-tenant | |
| status |
1..1 | code | draft | active | inactive | not-done | entered-in-error | unknown | |
| Slices for category |
1..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Slice: Unordered, Open by value:coding.system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| category:permission |
1..1 | CodeableConcept | Which permission this resource records Binding: Consent Permission Value Set (required) | |
| coding |
1..1 | Coding | Code defined by a terminology system | |
| system |
1..1 | uri | Identity of the terminology system Required Pattern: https://fhir.savannahghi.org/ig/healthy-route/CodeSystem/hr-consent-permission | |
| subject |
1..1 | Reference(Healthy Route Patient) | Who the consent applies to | |
| date |
1..1 | date | Date the participant signed | |
| period |
0..1 | Period | Period over which the permission applies | |
| grantor |
1..1 | Reference(Healthy Route Patient | RelatedPerson) | Who is granting rights according to the policy and rules | |
| grantee |
1..* | Reference(Healthy Route Organization) | Party the permission is granted to | |
| controller |
0..* | Reference(Healthy Route Organization) | Data controller | |
| sourceReference |
0..1 | Reference(Healthy Route Consent Evidence) | The photographed signed page | |
| regulatoryBasis |
0..* | CodeableConcept | Regulatory framework the consent was taken under | |
| policyBasis |
1..1 | BackboneElement | Computable version of the backing policy | |
| url |
1..1 | url | Versioned identifier of the approved information sheet | |
| policyText |
0..* | Reference(Healthy Route Document) | The approved blank information sheet and consent form | |
| verification |
1..1 | BackboneElement | Consent Verified by patient or family | |
| verified |
1..1 | boolean | Has been verified | |
| verifiedBy |
1..1 | Reference(Healthy Route Practitioner) | Person who took consent | |
| verificationDate |
1..1 | dateTime | When consent verified | |
| decision |
1..1 | code | permit or deny | |
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Status | Usage | ValueSet | Version | Source |
| Consent.category:permission | Base | required | Consent Permission Value Set | 📦0.1.0 | This IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Consent |
0..* | Consent | 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 | |||||
| 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: AllLanguages (required): IETF language tag for a human language
| |||||
| 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 | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| extension:tenant |
1..1 | Identifier | Owning site tenant URL: https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-tenant | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
0..* | Identifier | Identifier for this record (external references) | |||||
| status |
1..1 | code | draft | active | inactive | not-done | entered-in-error | unknown Binding: ConsentState (required): Indicates the state of the consent. | |||||
| Slices for category |
1..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Slice: Unordered, Open by value:coding.system Binding: ConsentCategoryCodes (example): A classification of the type of consents found in a consent statement. Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| category:permission |
1..1 | CodeableConcept | Which permission this resource records Binding: Consent Permission Value Set (required) | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
1..1 | Coding | Code defined by a terminology system | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Identity of the terminology system Required Pattern: https://fhir.savannahghi.org/ig/healthy-route/CodeSystem/hr-consent-permission | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
C | 0..1 | code | Symbol in syntax defined by the system | ||||
| display |
C | 0..1 | string | Representation defined by the system | ||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| subject |
1..1 | Reference(Healthy Route Patient) | Who the consent applies to | |||||
| date |
1..1 | date | Date the participant signed | |||||
| period |
0..1 | Period | Period over which the permission applies | |||||
| grantor |
1..1 | Reference(Healthy Route Patient | RelatedPerson) | Who is granting rights according to the policy and rules | |||||
| grantee |
1..* | Reference(Healthy Route Organization) | Party the permission is granted to | |||||
| manager |
0..* | Reference(HealthcareService | Organization | Patient | Practitioner) | Consent workflow management | |||||
| controller |
0..* | Reference(Healthy Route Organization) | Data controller | |||||
| sourceAttachment |
0..* | Attachment | Source from which this consent is taken | |||||
| sourceReference |
0..1 | Reference(Healthy Route Consent Evidence) | The photographed signed page | |||||
| regulatoryBasis |
0..* | CodeableConcept | Regulatory framework the consent was taken under Binding: ConsentPolicyRuleCodes (example): Regulatory policy examples | |||||
| policyBasis |
1..1 | BackboneElement | Computable version of the backing policy | |||||
| 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 | |||||
| reference |
0..1 | Reference(Resource) | Reference backing policy resource | |||||
| url |
1..1 | url | Versioned identifier of the approved information sheet | |||||
| policyText |
0..* | Reference(Healthy Route Document) | The approved blank information sheet and consent form | |||||
| verification |
1..1 | 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 | |||||
| verificationType |
0..1 | CodeableConcept | Business case of verification Binding: ConsentVerificationCodes (example): Types of Verification/Validation. | |||||
| verifiedBy |
1..1 | Reference(Healthy Route Practitioner) | Person who took consent | |||||
| verifiedWith |
0..1 | Reference(Patient | RelatedPerson) | Person who verified | |||||
| verificationDate |
1..1 | dateTime | When consent verified | |||||
| decision |
1..1 | code | permit or deny Binding: ConsentProvisionType (required): Sets the base decision for Consent to be either permit or deny, with provisions assumed to be a negation of the previous level. | |||||
| provision |
0..* | BackboneElement | Constraints to the base Consent.policyRule/Consent.policy | |||||
| 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 | |||||
| period |
0..1 | Period | Timeframe for this provision | |||||
| actor |
0..* | BackboneElement | Who|what controlled by this provision (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 |
0..1 | CodeableConcept | How the actor is involved Binding: ParticipationRoleType (extensible): How an actor is involved in the consent considerations. | |||||
| reference |
0..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Resource for the actor (or group, by role) | |||||
| action |
0..* | CodeableConcept | Actions controlled by this provision Binding: ConsentActionCodes (example): Detailed codes for the consent action. | |||||
| securityLabel |
0..* | Coding | Security Labels that define affected resources Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System. | |||||
| purpose |
0..* | Coding | Context of activities covered by this provision 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. | |||||
| documentType |
0..* | Coding | e.g. Resource Type, Profile, CDA, etc Binding: ConsentContentClass (preferred): The document type a consent provision covers. | |||||
| resourceType |
0..* | Coding | e.g. Resource Type, Profile, etc Binding: ResourceType (extensible): The resource types a consent provision covers. | |||||
| code |
0..* | CodeableConcept | 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. | |||||
| dataPeriod |
0..1 | Period | Timeframe for data controlled by this provision | |||||
| data |
0..* | BackboneElement | Data controlled by this provision | |||||
| 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 | Reference(Resource) | The actual data reference | |||||
| expression |
0..1 | Expression | A computable expression of the consent | |||||
| provision |
0..* | See provision (Consent) | Nested Exception Provisions | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Consent.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| Consent.status | Base | required | Consent State | 📍5.0.0 | FHIR Std. |
| Consent.category | Base | example | Consent Category Codes | 📍5.0.0 | FHIR Std. |
| Consent.category:permission | Base | required | Consent Permission Value Set | 📦0.1.0 | This IG |
| Consent.regulatoryBasis | Base | example | Consent PolicyRule Codes | 📍5.0.0 | FHIR Std. |
| Consent.verification.verificationType | Base | example | Consent Vefication Codes | 📍5.0.0 | FHIR Std. |
| Consent.decision | Base | required | Consent Provision Type | 📍5.0.0 | FHIR Std. |
| Consent.provision.actor.role | Base | extensible | Participation Role Type | 📍5.0.0 | FHIR Std. |
| Consent.provision.action | Base | example | Consent Action Codes | 📍5.0.0 | FHIR Std. |
| Consent.provision.securityLabel | Base | example | Example set of Security Labels | 📍5.0.0 | FHIR Std. |
| Consent.provision.purpose | Base | extensible | PurposeOfUse | 📦3.1.0 | THO v7.4 |
| Consent.provision.documentType | Base | preferred | Consent Content Class | 📍5.0.0 | FHIR Std. |
| Consent.provision.resourceType | Base | extensible | Resource Types | 📍5.0.0 | FHIR Std. |
| Consent.provision.code | Base | example | Consent Content Codes | 📍5.0.0 | FHIR Std. |
| Consent.provision.data.meaning | Base | required | Consent Data Meaning | 📍5.0.0 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from Consent
Summary
Mandatory: 16 elements
Must-Support: 22 elements
Structures
This structure refers to these other structures:
- Healthy Route Patient (https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-patient)
- Healthy Route Organization (https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-organization)
- Healthy Route Consent Evidence (https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-consent-evidence)
- Healthy Route Document (https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-document-reference)
- Healthy Route Practitioner (https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-practitioner)
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
- The element 1 is sliced based on the value of Consent.category
Other representations of profile: CSV, Excel, Schematron