Inera Core Implementation Guide
0.2.0 - ci-build Sweden

Inera Core Implementation Guide - Local Development build (v0.2.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Consent Base Inera ( Experimental )

Official URL: https://inera.se/fhir/core/StructureDefinition/consent-base-inera Version: 0.2.0
Draft as of 2025-11-24 Computable Name: ConsentBaseInera

Svensk profil för patientspärrar (blocks) baserad på TKB GetBlocks v2.0.

Används för att dokumentera:

  • Inre spärr (inom vårdgivare)
  • Yttre spärr (nationell NPÖ-spärr)
  • Samtycke och spärrar enligt PDL

PDL-krävs: Dokumentation enligt Patientdatalagen (SFS 2008:355)

Källa: TKB GetBlocks v2.0 (ehr:accesscontrol)

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

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 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 SΣ 0..* Identifier Spärr-ID

Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"}
... status ?!SΣ 1..1 code Status
Binding: ConsentState (required)
... scope ?!SΣ 1..1 CodeableConcept Omfattning
Binding: ConsentScopeCodes (extensible)
.... Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:code
..... coding:patientPrivacy SΣ 1..1 Coding Code defined by a terminology system
...... system Σ 0..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope
...... code Σ 1..1 code Symbol in syntax defined by the system
Fixed Value: patient-privacy
... category SΣ 1..* CodeableConcept Kategori
Binding: ConsentCategoryCodes (extensible)
... patient SΣ 1..1 Reference(Patient Base Inera) Patient
... dateTime SΣ 0..1 dateTime Registreringsdatum
... performer SΣ 0..* Reference(PractitionerRole Base Inera | Organization Base Inera | Patient Base Inera | RelatedPerson) Registrerade spärren
... organization SΣ 0..* Reference(Organization Base Inera) Vårdgivare som spärrat
... source[x] SΣ 0..1 Källa för spärr
.... sourceAttachment Attachment
.... sourceReference Reference(Consent | DocumentReference | Contract | QuestionnaireResponse)
... policy S 0..* BackboneElement Policy
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... authority SC 0..1 uri Policyutgivare
.... uri SC 0..1 uri Policy-URI
... policyRule SΣC 0..1 CodeableConcept Policyregel
Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples.
... verification SΣ 0..* BackboneElement Verifiering
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... verified SΣ 1..1 boolean Verifierad
.... verifiedWith S 0..1 Reference(Patient Base Inera | RelatedPerson) Verifierad med
.... verificationDate S 0..1 dateTime Verifieringsdatum
... provision SΣ 0..1 BackboneElement Bestämmelser
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type SΣ 1..1 code Typ
Binding: ConsentProvisionType (required)
.... period SΣ 0..1 Period Giltighetstid
.... actor S 0..* BackboneElement Aktör
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... role S 1..1 CodeableConcept Roll
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.
..... reference S 1..1 Reference(PractitionerRole Base Inera | Organization Base Inera | Device | Patient Base Inera | RelatedPerson) Blockerad aktör
.... action SΣ 0..* CodeableConcept Åtgärd
Binding: ConsentActionCodes (example): Detailed codes for the consent action.
.... securityLabel SΣ 0..* Coding Säkerhetsmärkning
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... purpose SΣ 0..* Coding Syfte
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 SΣ 0..* Coding Dataklass
Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers.
.... code SΣ 0..* CodeableConcept Datakod
Binding: ConsentContentCodes (example): If this code is found in an instance, then the exception applies.
.... dataPeriod SΣ 0..1 Period Dataperiod
.... data SΣ 0..* BackboneElement Specifik data
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... meaning SΣ 1..1 code Betydelse
Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions.
..... reference SΣ 1..1 Reference(Resource) Datareferens
.... provision S 0..* See provision (Consent) Underbestämmelser

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Consent.status Base required ConsentState 📦4.0.1 FHIR Std.
Consent.scope Base extensible Consent Scope Codes 📦4.0.1 FHIR Std.
Consent.category Base extensible Consent Category Codes 📦4.0.1 FHIR Std.
Consent.policyRule Base extensible Consent PolicyRule Codes 📍4.0.1 FHIR Std.
Consent.provision.type Base required ConsentProvisionType 📦4.0.1 FHIR Std.
Consent.provision.actor.​role Base extensible SecurityRoleType 📍4.0.1 FHIR Std.
Consent.provision.action Base example Consent Action Codes 📍4.0.1 FHIR Std.
Consent.provision.securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Consent.provision.purpose Base extensible PurposeOfUse 📦3.1.0 THO v7.0
Consent.provision.class Base extensible Consent Content Class 📍4.0.1 FHIR Std.
Consent.provision.code Base example Consent Content Codes 📍4.0.1 FHIR Std.
Consent.provision.data.​meaning Base required ConsentDataMeaning 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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 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(canonical) = '#').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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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 S 0..* Identifier Spärr-ID
... status S 1..1 code Status
Binding: ConsentState (required)
... scope S 1..1 CodeableConcept Omfattning
Binding: ConsentScopeCodes (extensible)
.... Slices for coding 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:code
..... coding:patientPrivacy S 1..1 Coding Code defined by a terminology system
...... system 0..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: patient-privacy
... category S 1..* CodeableConcept Kategori
Binding: ConsentCategoryCodes (extensible)
... patient S 1..1 Reference(Patient Base Inera) Patient
... dateTime S 0..1 dateTime Registreringsdatum
... performer S 0..* Reference(PractitionerRole Base Inera | Organization Base Inera | Patient Base Inera | RelatedPerson) Registrerade spärren
... organization S 0..* Reference(Organization Base Inera) Vårdgivare som spärrat
... source[x] S 0..1 Attachment, Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) Källa för spärr
... policy S 0..* BackboneElement Policy
.... authority S 0..1 uri Policyutgivare
.... uri S 0..1 uri Policy-URI
... policyRule S 0..1 CodeableConcept Policyregel
... verification S 0..* BackboneElement Verifiering
.... verified S 1..1 boolean Verifierad
.... verifiedWith S 0..1 Reference(Patient Base Inera | RelatedPerson) Verifierad med
.... verificationDate S 0..1 dateTime Verifieringsdatum
... provision S 0..1 BackboneElement Bestämmelser
.... type S 1..1 code Typ
Binding: ConsentProvisionType (required)
.... period S 0..1 Period Giltighetstid
.... actor S 0..* BackboneElement Aktör
..... role S 1..1 CodeableConcept Roll
..... reference S 1..1 Reference(PractitionerRole Base Inera | Organization Base Inera | Device | Patient Base Inera | RelatedPerson) Blockerad aktör
.... action S 0..* CodeableConcept Åtgärd
.... securityLabel S 0..* Coding Säkerhetsmärkning
.... purpose S 0..* Coding Syfte
.... class S 0..* Coding Dataklass
.... code S 0..* CodeableConcept Datakod
.... dataPeriod S 0..1 Period Dataperiod
.... data S 0..* BackboneElement Specifik data
..... meaning S 1..1 code Betydelse
..... reference S 1..1 Reference(Resource) Datareferens
.... provision S 0..* Underbestämmelser

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Consent.status Base required ConsentState 📦4.0.1 FHIR Std.
Consent.scope Base extensible Consent Scope Codes 📦4.0.1 FHIR Std.
Consent.category Base extensible Consent Category Codes 📦4.0.1 FHIR Std.
Consent.provision.type Base required ConsentProvisionType 📦4.0.1 FHIR Std.
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... 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 SΣ 0..* Identifier Spärr-ID

Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"}
... status ?!SΣ 1..1 code Status
Binding: ConsentState (required)
... scope ?!SΣ 1..1 CodeableConcept Omfattning
Binding: ConsentScopeCodes (extensible)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:code
..... coding:patientPrivacy SΣ 1..1 Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 0..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
Fixed Value: patient-privacy
...... display Σ 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
... category SΣ 1..* CodeableConcept Kategori
Binding: ConsentCategoryCodes (extensible)
... patient SΣ 1..1 Reference(Patient Base Inera) Patient
... dateTime SΣ 0..1 dateTime Registreringsdatum
... performer SΣ 0..* Reference(PractitionerRole Base Inera | Organization Base Inera | Patient Base Inera | RelatedPerson) Registrerade spärren
... organization SΣ 0..* Reference(Organization Base Inera) Vårdgivare som spärrat
... source[x] SΣ 0..1 Källa för spärr
.... sourceAttachment Attachment
.... sourceReference Reference(Consent | DocumentReference | Contract | QuestionnaireResponse)
... policy S 0..* BackboneElement 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
.... authority SC 0..1 uri Policyutgivare
.... uri SC 0..1 uri Policy-URI
... policyRule SΣC 0..1 CodeableConcept Policyregel
Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples.
... verification SΣ 0..* BackboneElement Verifiering
.... 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 SΣ 1..1 boolean Verifierad
.... verifiedWith S 0..1 Reference(Patient Base Inera | RelatedPerson) Verifierad med
.... verificationDate S 0..1 dateTime Verifieringsdatum
... provision SΣ 0..1 BackboneElement Bestämmelser
.... 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 SΣ 1..1 code Typ
Binding: ConsentProvisionType (required)
.... period SΣ 0..1 Period Giltighetstid
.... actor S 0..* BackboneElement Aktör
..... 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 S 1..1 CodeableConcept Roll
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.
..... reference S 1..1 Reference(PractitionerRole Base Inera | Organization Base Inera | Device | Patient Base Inera | RelatedPerson) Blockerad aktör
.... action SΣ 0..* CodeableConcept Åtgärd
Binding: ConsentActionCodes (example): Detailed codes for the consent action.
.... securityLabel SΣ 0..* Coding Säkerhetsmärkning
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... purpose SΣ 0..* Coding Syfte
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 SΣ 0..* Coding Dataklass
Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers.
.... code SΣ 0..* CodeableConcept Datakod
Binding: ConsentContentCodes (example): If this code is found in an instance, then the exception applies.
.... dataPeriod SΣ 0..1 Period Dataperiod
.... data SΣ 0..* BackboneElement Specifik data
..... 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 SΣ 1..1 code Betydelse
Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions.
..... reference SΣ 1..1 Reference(Resource) Datareferens
.... provision S 0..* See provision (Consent) Underbestämmelser

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Consent.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Consent.status Base required ConsentState 📦4.0.1 FHIR Std.
Consent.scope Base extensible Consent Scope Codes 📦4.0.1 FHIR Std.
Consent.category Base extensible Consent Category Codes 📦4.0.1 FHIR Std.
Consent.policyRule Base extensible Consent PolicyRule Codes 📍4.0.1 FHIR Std.
Consent.provision.type Base required ConsentProvisionType 📦4.0.1 FHIR Std.
Consent.provision.actor.​role Base extensible SecurityRoleType 📍4.0.1 FHIR Std.
Consent.provision.action Base example Consent Action Codes 📍4.0.1 FHIR Std.
Consent.provision.securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Consent.provision.purpose Base extensible PurposeOfUse 📦3.1.0 THO v7.0
Consent.provision.class Base extensible Consent Content Class 📍4.0.1 FHIR Std.
Consent.provision.code Base example Consent Content Codes 📍4.0.1 FHIR Std.
Consent.provision.data.​meaning Base required ConsentDataMeaning 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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 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(canonical) = '#').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

Summary

Mandatory: 4 elements(1 nested mandatory element)
Must-Support: 34 elements
Fixed: 2 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Consent.scope.coding

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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 SΣ 0..* Identifier Spärr-ID

Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"}
... status ?!SΣ 1..1 code Status
Binding: ConsentState (required)
... scope ?!SΣ 1..1 CodeableConcept Omfattning
Binding: ConsentScopeCodes (extensible)
.... Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:code
..... coding:patientPrivacy SΣ 1..1 Coding Code defined by a terminology system
...... system Σ 0..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope
...... code Σ 1..1 code Symbol in syntax defined by the system
Fixed Value: patient-privacy
... category SΣ 1..* CodeableConcept Kategori
Binding: ConsentCategoryCodes (extensible)
... patient SΣ 1..1 Reference(Patient Base Inera) Patient
... dateTime SΣ 0..1 dateTime Registreringsdatum
... performer SΣ 0..* Reference(PractitionerRole Base Inera | Organization Base Inera | Patient Base Inera | RelatedPerson) Registrerade spärren
... organization SΣ 0..* Reference(Organization Base Inera) Vårdgivare som spärrat
... source[x] SΣ 0..1 Källa för spärr
.... sourceAttachment Attachment
.... sourceReference Reference(Consent | DocumentReference | Contract | QuestionnaireResponse)
... policy S 0..* BackboneElement Policy
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... authority SC 0..1 uri Policyutgivare
.... uri SC 0..1 uri Policy-URI
... policyRule SΣC 0..1 CodeableConcept Policyregel
Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples.
... verification SΣ 0..* BackboneElement Verifiering
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... verified SΣ 1..1 boolean Verifierad
.... verifiedWith S 0..1 Reference(Patient Base Inera | RelatedPerson) Verifierad med
.... verificationDate S 0..1 dateTime Verifieringsdatum
... provision SΣ 0..1 BackboneElement Bestämmelser
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type SΣ 1..1 code Typ
Binding: ConsentProvisionType (required)
.... period SΣ 0..1 Period Giltighetstid
.... actor S 0..* BackboneElement Aktör
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... role S 1..1 CodeableConcept Roll
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.
..... reference S 1..1 Reference(PractitionerRole Base Inera | Organization Base Inera | Device | Patient Base Inera | RelatedPerson) Blockerad aktör
.... action SΣ 0..* CodeableConcept Åtgärd
Binding: ConsentActionCodes (example): Detailed codes for the consent action.
.... securityLabel SΣ 0..* Coding Säkerhetsmärkning
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... purpose SΣ 0..* Coding Syfte
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 SΣ 0..* Coding Dataklass
Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers.
.... code SΣ 0..* CodeableConcept Datakod
Binding: ConsentContentCodes (example): If this code is found in an instance, then the exception applies.
.... dataPeriod SΣ 0..1 Period Dataperiod
.... data SΣ 0..* BackboneElement Specifik data
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... meaning SΣ 1..1 code Betydelse
Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions.
..... reference SΣ 1..1 Reference(Resource) Datareferens
.... provision S 0..* See provision (Consent) Underbestämmelser

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Consent.status Base required ConsentState 📦4.0.1 FHIR Std.
Consent.scope Base extensible Consent Scope Codes 📦4.0.1 FHIR Std.
Consent.category Base extensible Consent Category Codes 📦4.0.1 FHIR Std.
Consent.policyRule Base extensible Consent PolicyRule Codes 📍4.0.1 FHIR Std.
Consent.provision.type Base required ConsentProvisionType 📦4.0.1 FHIR Std.
Consent.provision.actor.​role Base extensible SecurityRoleType 📍4.0.1 FHIR Std.
Consent.provision.action Base example Consent Action Codes 📍4.0.1 FHIR Std.
Consent.provision.securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Consent.provision.purpose Base extensible PurposeOfUse 📦3.1.0 THO v7.0
Consent.provision.class Base extensible Consent Content Class 📍4.0.1 FHIR Std.
Consent.provision.code Base example Consent Content Codes 📍4.0.1 FHIR Std.
Consent.provision.data.​meaning Base required ConsentDataMeaning 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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 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(canonical) = '#').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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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 S 0..* Identifier Spärr-ID
... status S 1..1 code Status
Binding: ConsentState (required)
... scope S 1..1 CodeableConcept Omfattning
Binding: ConsentScopeCodes (extensible)
.... Slices for coding 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:code
..... coding:patientPrivacy S 1..1 Coding Code defined by a terminology system
...... system 0..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: patient-privacy
... category S 1..* CodeableConcept Kategori
Binding: ConsentCategoryCodes (extensible)
... patient S 1..1 Reference(Patient Base Inera) Patient
... dateTime S 0..1 dateTime Registreringsdatum
... performer S 0..* Reference(PractitionerRole Base Inera | Organization Base Inera | Patient Base Inera | RelatedPerson) Registrerade spärren
... organization S 0..* Reference(Organization Base Inera) Vårdgivare som spärrat
... source[x] S 0..1 Attachment, Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) Källa för spärr
... policy S 0..* BackboneElement Policy
.... authority S 0..1 uri Policyutgivare
.... uri S 0..1 uri Policy-URI
... policyRule S 0..1 CodeableConcept Policyregel
... verification S 0..* BackboneElement Verifiering
.... verified S 1..1 boolean Verifierad
.... verifiedWith S 0..1 Reference(Patient Base Inera | RelatedPerson) Verifierad med
.... verificationDate S 0..1 dateTime Verifieringsdatum
... provision S 0..1 BackboneElement Bestämmelser
.... type S 1..1 code Typ
Binding: ConsentProvisionType (required)
.... period S 0..1 Period Giltighetstid
.... actor S 0..* BackboneElement Aktör
..... role S 1..1 CodeableConcept Roll
..... reference S 1..1 Reference(PractitionerRole Base Inera | Organization Base Inera | Device | Patient Base Inera | RelatedPerson) Blockerad aktör
.... action S 0..* CodeableConcept Åtgärd
.... securityLabel S 0..* Coding Säkerhetsmärkning
.... purpose S 0..* Coding Syfte
.... class S 0..* Coding Dataklass
.... code S 0..* CodeableConcept Datakod
.... dataPeriod S 0..1 Period Dataperiod
.... data S 0..* BackboneElement Specifik data
..... meaning S 1..1 code Betydelse
..... reference S 1..1 Reference(Resource) Datareferens
.... provision S 0..* Underbestämmelser

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Consent.status Base required ConsentState 📦4.0.1 FHIR Std.
Consent.scope Base extensible Consent Scope Codes 📦4.0.1 FHIR Std.
Consent.category Base extensible Consent Category Codes 📦4.0.1 FHIR Std.
Consent.provision.type Base required ConsentProvisionType 📦4.0.1 FHIR Std.

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... 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 SΣ 0..* Identifier Spärr-ID

Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"}
... status ?!SΣ 1..1 code Status
Binding: ConsentState (required)
... scope ?!SΣ 1..1 CodeableConcept Omfattning
Binding: ConsentScopeCodes (extensible)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:code
..... coding:patientPrivacy SΣ 1..1 Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 0..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
Fixed Value: patient-privacy
...... display Σ 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
... category SΣ 1..* CodeableConcept Kategori
Binding: ConsentCategoryCodes (extensible)
... patient SΣ 1..1 Reference(Patient Base Inera) Patient
... dateTime SΣ 0..1 dateTime Registreringsdatum
... performer SΣ 0..* Reference(PractitionerRole Base Inera | Organization Base Inera | Patient Base Inera | RelatedPerson) Registrerade spärren
... organization SΣ 0..* Reference(Organization Base Inera) Vårdgivare som spärrat
... source[x] SΣ 0..1 Källa för spärr
.... sourceAttachment Attachment
.... sourceReference Reference(Consent | DocumentReference | Contract | QuestionnaireResponse)
... policy S 0..* BackboneElement 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
.... authority SC 0..1 uri Policyutgivare
.... uri SC 0..1 uri Policy-URI
... policyRule SΣC 0..1 CodeableConcept Policyregel
Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples.
... verification SΣ 0..* BackboneElement Verifiering
.... 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 SΣ 1..1 boolean Verifierad
.... verifiedWith S 0..1 Reference(Patient Base Inera | RelatedPerson) Verifierad med
.... verificationDate S 0..1 dateTime Verifieringsdatum
... provision SΣ 0..1 BackboneElement Bestämmelser
.... 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 SΣ 1..1 code Typ
Binding: ConsentProvisionType (required)
.... period SΣ 0..1 Period Giltighetstid
.... actor S 0..* BackboneElement Aktör
..... 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 S 1..1 CodeableConcept Roll
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.
..... reference S 1..1 Reference(PractitionerRole Base Inera | Organization Base Inera | Device | Patient Base Inera | RelatedPerson) Blockerad aktör
.... action SΣ 0..* CodeableConcept Åtgärd
Binding: ConsentActionCodes (example): Detailed codes for the consent action.
.... securityLabel SΣ 0..* Coding Säkerhetsmärkning
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... purpose SΣ 0..* Coding Syfte
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 SΣ 0..* Coding Dataklass
Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers.
.... code SΣ 0..* CodeableConcept Datakod
Binding: ConsentContentCodes (example): If this code is found in an instance, then the exception applies.
.... dataPeriod SΣ 0..1 Period Dataperiod
.... data SΣ 0..* BackboneElement Specifik data
..... 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 SΣ 1..1 code Betydelse
Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions.
..... reference SΣ 1..1 Reference(Resource) Datareferens
.... provision S 0..* See provision (Consent) Underbestämmelser

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Consent.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Consent.status Base required ConsentState 📦4.0.1 FHIR Std.
Consent.scope Base extensible Consent Scope Codes 📦4.0.1 FHIR Std.
Consent.category Base extensible Consent Category Codes 📦4.0.1 FHIR Std.
Consent.policyRule Base extensible Consent PolicyRule Codes 📍4.0.1 FHIR Std.
Consent.provision.type Base required ConsentProvisionType 📦4.0.1 FHIR Std.
Consent.provision.actor.​role Base extensible SecurityRoleType 📍4.0.1 FHIR Std.
Consent.provision.action Base example Consent Action Codes 📍4.0.1 FHIR Std.
Consent.provision.securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Consent.provision.purpose Base extensible PurposeOfUse 📦3.1.0 THO v7.0
Consent.provision.class Base extensible Consent Content Class 📍4.0.1 FHIR Std.
Consent.provision.code Base example Consent Content Codes 📍4.0.1 FHIR Std.
Consent.provision.data.​meaning Base required ConsentDataMeaning 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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 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(canonical) = '#').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

Summary

Mandatory: 4 elements(1 nested mandatory element)
Must-Support: 34 elements
Fixed: 2 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Consent.scope.coding

 

Other representations of profile: CSV, Excel, Schematron