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: SGHI Consent

Official URL: https://fhir.slade360.co.ke/fhir/StructureDefinition/sghi-consent Version: 0.1.0
Draft as of 2025-09-04 Computable Name: SGHIConsent

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.

Usages:

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.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ 0..1 SGHICodeableConcept Description of identifier
Binding: SGHI Standard Identifier Types (required)
.... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value ΣC 1..1 string The value that is unique
Example General: 123456
.... assigner Σ 1..1 SGHIReference(SGHI Organization) Organization that issued id (may be just text)
... status ?!Σ 1..1 code draft | active | inactive | not-done | entered-in-error | unknown
Binding: ConsentState (required): Indicates the state of the consent.
... category Σ 1..* SGHICodeableConcept Classification of the consent statement - for indexing/retrieval
Binding: ConsentCategoryCodes (example): A classification of the type of consents found in a consent statement.
... subject Σ 1..1 SGHIReference(SGHI Patient) Who the consent applies to
... date Σ 1..1 date Fully executed date of the consent
... grantor Σ 1..1 SGHIReference(SGHI Organization | SGHI Patient) Who is granting rights according to the policy and rules
... grantee Σ 1..1 SGHIReference(SGHI Patient | SGHI Organization) Who is agreeing to the policy and rules
... manager 1..* SGHIReference(SGHI Organization | SGHI Patient) Consent workflow management
... controller 1..1 SGHIReference(SGHI Organization | SGHI Patient) Consent Enforcer
... sourceAttachment S 0..* SGHIAttachment Source from which this consent is taken
... sourceReference 0..* SGHIReference(SGHI Consent) Source from which this consent is taken
... regulatoryBasis 0..* SGHICodeableConcept Regulations establishing base Consent
Binding: ConsentPolicyRuleCodes (example): Regulatory policy examples
... policyText 0..* SGHIReference(DocumentReference) Human Readable Policy
... verification Σ 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
.... verificationType 0..1 SGHICodeableConcept Business case of verification
Binding: ConsentVerificationCodes (example): Types of Verification/Validation.
.... verifiedBy 1..1 SGHIReference(SGHI Organization) Person conducting verification
.... verifiedWith 1..1 SGHIReference(SGHI Patient) Person who verified
.... verificationDate 1..1 dateTime When consent verified
... decision ?!Σ 1..1 code deny | permit
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.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Consent.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use
From the FHIR Standard
Consent.identifier.typerequiredSGHIIdentifierTypes
https://fhir.slade360.co.ke/fhir/ValueSet/sghi-identifier-types
From this IG
Consent.statusrequiredConsentState
http://hl7.org/fhir/ValueSet/consent-state-codes|5.0.0
From the FHIR Standard
Consent.categoryexampleConsentCategoryCodes
http://hl7.org/fhir/ValueSet/consent-category
From the FHIR Standard
Consent.regulatoryBasisexampleConsentPolicyRuleCodes
http://hl7.org/fhir/ValueSet/consent-policy
From the FHIR Standard
Consent.verification.verificationTypeexampleConsentVerificationCodes
http://hl7.org/fhir/ValueSet/consent-verification
From the FHIR Standard
Consent.decisionrequiredConsentProvisionType
http://hl7.org/fhir/ValueSet/consent-provision-type|5.0.0
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorConsentIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorConsentIf 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-4errorConsentIf 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-5errorConsentIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceConsentA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Consent

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... identifier 1..* Identifier Identifier for this record (external references)
.... use 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type 0..1 SGHICodeableConcept Description of identifier
Binding: SGHI Standard Identifier Types (required)
.... system 1..1 uri The namespace for the identifier value
.... value 1..1 string The value that is unique
.... assigner 1..1 SGHIReference(SGHI Organization) Organization that issued id (may be just text)
... category 1..* SGHICodeableConcept Classification of the consent statement - for indexing/retrieval
... subject 1..1 SGHIReference(SGHI Patient) Who the consent applies to
... grantor 1..1 SGHIReference(SGHI Organization | SGHI Patient) Who is granting rights according to the policy and rules
... grantee 1..1 SGHIReference(SGHI Patient | SGHI Organization) Who is agreeing to the policy and rules
... manager 1..* SGHIReference(SGHI Organization | SGHI Patient) Consent workflow management
... controller 1..1 SGHIReference(SGHI Organization | SGHI Patient) Consent Enforcer
... sourceAttachment S 0..* SGHIAttachment Source from which this consent is taken
... sourceReference 0..* SGHIReference(SGHI Consent) Source from which this consent is taken
... regulatoryBasis 0..* SGHICodeableConcept Regulations establishing base Consent
... policyBasis
.... reference 0..1 SGHIReference(Resource) Reference backing policy resource
... policyText 0..* SGHIReference(DocumentReference) Human Readable Policy
... verification 1..* BackboneElement Consent Verified by patient or family
.... verificationType 0..1 SGHICodeableConcept Business case of verification
.... verifiedBy 1..1 SGHIReference(SGHI Organization) Person conducting verification
.... verifiedWith 1..1 SGHIReference(SGHI Patient) Person who verified
.... verificationDate 1..1 dateTime When consent verified
... decision 1..1 code deny | permit
... provision
.... actor
..... role 0..1 SGHICodeableConcept How the actor is involved
..... reference 0..1 SGHIReference(SGHI Patient | SGHI Organization) Resource for the actor (or group, by role)
.... action 0..* SGHICodeableConcept Actions controlled by this provision
.... code 0..* SGHICodeableConcept e.g. LOINC or SNOMED CT code, etc. in the content
Binding: ConsentContentCodes (required)
.... data
..... reference 1..1 SGHIReference(Resource) The actual data reference

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Consent.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use
From the FHIR Standard
Consent.identifier.typerequiredSGHIIdentifierTypes
https://fhir.slade360.co.ke/fhir/ValueSet/sghi-identifier-types
From this IG
Consent.provision.coderequiredConsentContentCodes
http://hl7.org/fhir/ValueSet/consent-content-code
From the FHIR Standard
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... 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
... 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 ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ 0..1 SGHICodeableConcept Description of identifier
Binding: SGHI Standard Identifier Types (required)
.... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value ΣC 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 Σ 1..1 SGHIReference(SGHI Organization) Organization that issued id (may be just text)
... status ?!Σ 1..1 code draft | active | inactive | not-done | entered-in-error | unknown
Binding: ConsentState (required): Indicates the state of the consent.
... category Σ 1..* SGHICodeableConcept Classification of the consent statement - for indexing/retrieval
Binding: ConsentCategoryCodes (example): A classification of the type of consents found in a consent statement.
... subject Σ 1..1 SGHIReference(SGHI Patient) Who the consent applies to
... date Σ 1..1 date Fully executed date of the consent
... period Σ 0..1 Period Effective period for this Consent
... grantor Σ 1..1 SGHIReference(SGHI Organization | SGHI Patient) Who is granting rights according to the policy and rules
... grantee Σ 1..1 SGHIReference(SGHI Patient | SGHI Organization) Who is agreeing to the policy and rules
... manager 1..* SGHIReference(SGHI Organization | SGHI Patient) Consent workflow management
... controller 1..1 SGHIReference(SGHI Organization | SGHI Patient) Consent Enforcer
... sourceAttachment S 0..* SGHIAttachment Source from which this consent is taken
... sourceReference 0..* SGHIReference(SGHI Consent) Source from which this consent is taken
... regulatoryBasis 0..* SGHICodeableConcept Regulations establishing base Consent
Binding: ConsentPolicyRuleCodes (example): Regulatory policy examples
... policyBasis 0..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 SGHIReference(Resource) Reference backing policy resource
.... url 0..1 url URL to a computable backing policy
... policyText 0..* SGHIReference(DocumentReference) Human Readable Policy
... verification Σ 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 SGHICodeableConcept Business case of verification
Binding: ConsentVerificationCodes (example): Types of Verification/Validation.
.... verifiedBy 1..1 SGHIReference(SGHI Organization) Person conducting verification
.... verifiedWith 1..1 SGHIReference(SGHI Patient) Person who verified
.... verificationDate 1..1 dateTime When consent verified
... decision ?!Σ 1..1 code deny | permit
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 SGHICodeableConcept How the actor is involved
Binding: ParticipationRoleType (extensible): How an actor is involved in the consent considerations.
..... reference 0..1 SGHIReference(SGHI Patient | SGHI Organization) Resource for the actor (or group, by role)
.... action Σ 0..* SGHICodeableConcept 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..* SGHICodeableConcept e.g. LOINC or SNOMED CT code, etc. in the content
Binding: ConsentContentCodes (required)
.... 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 SGHIReference(Resource) The actual data reference
.... expression 0..1 Expression A computable expression of the consent
.... provision 0..* See provision (Consent) Nested Exception Provisions

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Consent.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
From the FHIR Standard
Consent.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use
From the FHIR Standard
Consent.identifier.typerequiredSGHIIdentifierTypes
https://fhir.slade360.co.ke/fhir/ValueSet/sghi-identifier-types
From this IG
Consent.statusrequiredConsentState
http://hl7.org/fhir/ValueSet/consent-state-codes|5.0.0
From the FHIR Standard
Consent.categoryexampleConsentCategoryCodes
http://hl7.org/fhir/ValueSet/consent-category
From the FHIR Standard
Consent.regulatoryBasisexampleConsentPolicyRuleCodes
http://hl7.org/fhir/ValueSet/consent-policy
From the FHIR Standard
Consent.verification.verificationTypeexampleConsentVerificationCodes
http://hl7.org/fhir/ValueSet/consent-verification
From the FHIR Standard
Consent.decisionrequiredConsentProvisionType
http://hl7.org/fhir/ValueSet/consent-provision-type|5.0.0
From the FHIR Standard
Consent.provision.actor.roleextensibleParticipationRoleType
http://hl7.org/fhir/ValueSet/participation-role-type
From the FHIR Standard
Consent.provision.actionexampleConsentActionCodes
http://hl7.org/fhir/ValueSet/consent-action
From the FHIR Standard
Consent.provision.securityLabelexampleSecurityLabelExamples
http://hl7.org/fhir/ValueSet/security-label-examples
From the FHIR Standard
Consent.provision.purposeextensiblePurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
Consent.provision.documentTypepreferredConsentContentClass
http://hl7.org/fhir/ValueSet/consent-content-class
From the FHIR Standard
Consent.provision.resourceTypeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Consent.provision.coderequiredConsentContentCodes
http://hl7.org/fhir/ValueSet/consent-content-code
From the FHIR Standard
Consent.provision.data.meaningrequiredConsentDataMeaning
http://hl7.org/fhir/ValueSet/consent-data-meaning|5.0.0
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorConsentIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorConsentIf 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-4errorConsentIf 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-5errorConsentIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceConsentA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ 0..1 SGHICodeableConcept Description of identifier
Binding: SGHI Standard Identifier Types (required)
.... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value ΣC 1..1 string The value that is unique
Example General: 123456
.... assigner Σ 1..1 SGHIReference(SGHI Organization) Organization that issued id (may be just text)
... status ?!Σ 1..1 code draft | active | inactive | not-done | entered-in-error | unknown
Binding: ConsentState (required): Indicates the state of the consent.
... category Σ 1..* SGHICodeableConcept Classification of the consent statement - for indexing/retrieval
Binding: ConsentCategoryCodes (example): A classification of the type of consents found in a consent statement.
... subject Σ 1..1 SGHIReference(SGHI Patient) Who the consent applies to
... date Σ 1..1 date Fully executed date of the consent
... grantor Σ 1..1 SGHIReference(SGHI Organization | SGHI Patient) Who is granting rights according to the policy and rules
... grantee Σ 1..1 SGHIReference(SGHI Patient | SGHI Organization) Who is agreeing to the policy and rules
... manager 1..* SGHIReference(SGHI Organization | SGHI Patient) Consent workflow management
... controller 1..1 SGHIReference(SGHI Organization | SGHI Patient) Consent Enforcer
... sourceAttachment S 0..* SGHIAttachment Source from which this consent is taken
... sourceReference 0..* SGHIReference(SGHI Consent) Source from which this consent is taken
... regulatoryBasis 0..* SGHICodeableConcept Regulations establishing base Consent
Binding: ConsentPolicyRuleCodes (example): Regulatory policy examples
... policyText 0..* SGHIReference(DocumentReference) Human Readable Policy
... verification Σ 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
.... verificationType 0..1 SGHICodeableConcept Business case of verification
Binding: ConsentVerificationCodes (example): Types of Verification/Validation.
.... verifiedBy 1..1 SGHIReference(SGHI Organization) Person conducting verification
.... verifiedWith 1..1 SGHIReference(SGHI Patient) Person who verified
.... verificationDate 1..1 dateTime When consent verified
... decision ?!Σ 1..1 code deny | permit
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.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Consent.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use
From the FHIR Standard
Consent.identifier.typerequiredSGHIIdentifierTypes
https://fhir.slade360.co.ke/fhir/ValueSet/sghi-identifier-types
From this IG
Consent.statusrequiredConsentState
http://hl7.org/fhir/ValueSet/consent-state-codes|5.0.0
From the FHIR Standard
Consent.categoryexampleConsentCategoryCodes
http://hl7.org/fhir/ValueSet/consent-category
From the FHIR Standard
Consent.regulatoryBasisexampleConsentPolicyRuleCodes
http://hl7.org/fhir/ValueSet/consent-policy
From the FHIR Standard
Consent.verification.verificationTypeexampleConsentVerificationCodes
http://hl7.org/fhir/ValueSet/consent-verification
From the FHIR Standard
Consent.decisionrequiredConsentProvisionType
http://hl7.org/fhir/ValueSet/consent-provision-type|5.0.0
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorConsentIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorConsentIf 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-4errorConsentIf 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-5errorConsentIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceConsentA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from Consent

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... identifier 1..* Identifier Identifier for this record (external references)
.... use 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type 0..1 SGHICodeableConcept Description of identifier
Binding: SGHI Standard Identifier Types (required)
.... system 1..1 uri The namespace for the identifier value
.... value 1..1 string The value that is unique
.... assigner 1..1 SGHIReference(SGHI Organization) Organization that issued id (may be just text)
... category 1..* SGHICodeableConcept Classification of the consent statement - for indexing/retrieval
... subject 1..1 SGHIReference(SGHI Patient) Who the consent applies to
... grantor 1..1 SGHIReference(SGHI Organization | SGHI Patient) Who is granting rights according to the policy and rules
... grantee 1..1 SGHIReference(SGHI Patient | SGHI Organization) Who is agreeing to the policy and rules
... manager 1..* SGHIReference(SGHI Organization | SGHI Patient) Consent workflow management
... controller 1..1 SGHIReference(SGHI Organization | SGHI Patient) Consent Enforcer
... sourceAttachment S 0..* SGHIAttachment Source from which this consent is taken
... sourceReference 0..* SGHIReference(SGHI Consent) Source from which this consent is taken
... regulatoryBasis 0..* SGHICodeableConcept Regulations establishing base Consent
... policyBasis
.... reference 0..1 SGHIReference(Resource) Reference backing policy resource
... policyText 0..* SGHIReference(DocumentReference) Human Readable Policy
... verification 1..* BackboneElement Consent Verified by patient or family
.... verificationType 0..1 SGHICodeableConcept Business case of verification
.... verifiedBy 1..1 SGHIReference(SGHI Organization) Person conducting verification
.... verifiedWith 1..1 SGHIReference(SGHI Patient) Person who verified
.... verificationDate 1..1 dateTime When consent verified
... decision 1..1 code deny | permit
... provision
.... actor
..... role 0..1 SGHICodeableConcept How the actor is involved
..... reference 0..1 SGHIReference(SGHI Patient | SGHI Organization) Resource for the actor (or group, by role)
.... action 0..* SGHICodeableConcept Actions controlled by this provision
.... code 0..* SGHICodeableConcept e.g. LOINC or SNOMED CT code, etc. in the content
Binding: ConsentContentCodes (required)
.... data
..... reference 1..1 SGHIReference(Resource) The actual data reference

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Consent.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use
From the FHIR Standard
Consent.identifier.typerequiredSGHIIdentifierTypes
https://fhir.slade360.co.ke/fhir/ValueSet/sghi-identifier-types
From this IG
Consent.provision.coderequiredConsentContentCodes
http://hl7.org/fhir/ValueSet/consent-content-code
From the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... 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
... 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 ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ 0..1 SGHICodeableConcept Description of identifier
Binding: SGHI Standard Identifier Types (required)
.... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value ΣC 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 Σ 1..1 SGHIReference(SGHI Organization) Organization that issued id (may be just text)
... status ?!Σ 1..1 code draft | active | inactive | not-done | entered-in-error | unknown
Binding: ConsentState (required): Indicates the state of the consent.
... category Σ 1..* SGHICodeableConcept Classification of the consent statement - for indexing/retrieval
Binding: ConsentCategoryCodes (example): A classification of the type of consents found in a consent statement.
... subject Σ 1..1 SGHIReference(SGHI Patient) Who the consent applies to
... date Σ 1..1 date Fully executed date of the consent
... period Σ 0..1 Period Effective period for this Consent
... grantor Σ 1..1 SGHIReference(SGHI Organization | SGHI Patient) Who is granting rights according to the policy and rules
... grantee Σ 1..1 SGHIReference(SGHI Patient | SGHI Organization) Who is agreeing to the policy and rules
... manager 1..* SGHIReference(SGHI Organization | SGHI Patient) Consent workflow management
... controller 1..1 SGHIReference(SGHI Organization | SGHI Patient) Consent Enforcer
... sourceAttachment S 0..* SGHIAttachment Source from which this consent is taken
... sourceReference 0..* SGHIReference(SGHI Consent) Source from which this consent is taken
... regulatoryBasis 0..* SGHICodeableConcept Regulations establishing base Consent
Binding: ConsentPolicyRuleCodes (example): Regulatory policy examples
... policyBasis 0..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 SGHIReference(Resource) Reference backing policy resource
.... url 0..1 url URL to a computable backing policy
... policyText 0..* SGHIReference(DocumentReference) Human Readable Policy
... verification Σ 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 SGHICodeableConcept Business case of verification
Binding: ConsentVerificationCodes (example): Types of Verification/Validation.
.... verifiedBy 1..1 SGHIReference(SGHI Organization) Person conducting verification
.... verifiedWith 1..1 SGHIReference(SGHI Patient) Person who verified
.... verificationDate 1..1 dateTime When consent verified
... decision ?!Σ 1..1 code deny | permit
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 SGHICodeableConcept How the actor is involved
Binding: ParticipationRoleType (extensible): How an actor is involved in the consent considerations.
..... reference 0..1 SGHIReference(SGHI Patient | SGHI Organization) Resource for the actor (or group, by role)
.... action Σ 0..* SGHICodeableConcept 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..* SGHICodeableConcept e.g. LOINC or SNOMED CT code, etc. in the content
Binding: ConsentContentCodes (required)
.... 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 SGHIReference(Resource) The actual data reference
.... expression 0..1 Expression A computable expression of the consent
.... provision 0..* See provision (Consent) Nested Exception Provisions

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Consent.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
From the FHIR Standard
Consent.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use
From the FHIR Standard
Consent.identifier.typerequiredSGHIIdentifierTypes
https://fhir.slade360.co.ke/fhir/ValueSet/sghi-identifier-types
From this IG
Consent.statusrequiredConsentState
http://hl7.org/fhir/ValueSet/consent-state-codes|5.0.0
From the FHIR Standard
Consent.categoryexampleConsentCategoryCodes
http://hl7.org/fhir/ValueSet/consent-category
From the FHIR Standard
Consent.regulatoryBasisexampleConsentPolicyRuleCodes
http://hl7.org/fhir/ValueSet/consent-policy
From the FHIR Standard
Consent.verification.verificationTypeexampleConsentVerificationCodes
http://hl7.org/fhir/ValueSet/consent-verification
From the FHIR Standard
Consent.decisionrequiredConsentProvisionType
http://hl7.org/fhir/ValueSet/consent-provision-type|5.0.0
From the FHIR Standard
Consent.provision.actor.roleextensibleParticipationRoleType
http://hl7.org/fhir/ValueSet/participation-role-type
From the FHIR Standard
Consent.provision.actionexampleConsentActionCodes
http://hl7.org/fhir/ValueSet/consent-action
From the FHIR Standard
Consent.provision.securityLabelexampleSecurityLabelExamples
http://hl7.org/fhir/ValueSet/security-label-examples
From the FHIR Standard
Consent.provision.purposeextensiblePurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
Consent.provision.documentTypepreferredConsentContentClass
http://hl7.org/fhir/ValueSet/consent-content-class
From the FHIR Standard
Consent.provision.resourceTypeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Consent.provision.coderequiredConsentContentCodes
http://hl7.org/fhir/ValueSet/consent-content-code
From the FHIR Standard
Consent.provision.data.meaningrequiredConsentDataMeaning
http://hl7.org/fhir/ValueSet/consent-data-meaning|5.0.0
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorConsentIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorConsentIf 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-4errorConsentIf 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-5errorConsentIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceConsentA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron