2025.2.0 - ci-build

IGTTPFHIRGatewaygICS - Local Development build (v2025.2.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Consent

Official URL: https://ths-greifswald.de/fhir/StructureDefinition/gics/Consent Version: 2025.2.0
Active as of 2025-06-12 Computable Name: Consent

Copyright/Legal: Copyright 2020-2025 Unabhängige Treuhandstelle der Universitätsmedizin Greifswald

Angepasstes FHIR Consent Profil auf Basis des offiziellen Consent-Profils der Hl7 AG Einwilligungsmanagement erweitertet um ausgewählte gICS Eigenschaften.

Strukturierte, maschinenverarbeitbare Abbildung von Einwilligungsdaten.

Such-Parameter

Die Consent Suchparameter sind separat dokumentiert.

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 C 0..* ConsentManagementConsent(2.0.2) A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
Constraints: ppc-4, ppc-5, ppc-2, ppc-3, ppc-1
... meta Σ 0..1 Meta Metadata about the resource
.... Slices for extension Content/Rules for all slices
..... extension:created S 0..1 instant Created
URL: https://ths-greifswald.de/fhir/StructureDefinition/gics/Created
.... lastUpdated SΣ 0..1 instant When the resource version last changed
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... extension:domainReference SN 0..* (Complex) Optional Extensions Element
URL: http://fhir.de/ConsentManagement/StructureDefinition/DomainReference
..... Slices for extension Content/Rules for all slices
...... extension:domain SN 1..1 Extension Additional content defined by implementations
....... url 1..1 uri "domain"
....... value[x] N 1..1 Reference(Consent Management Domain Organization(2.0.2) | Consent Management Domain Research Study(2.0.2)) Value of extension
...... extension:status N 0..1 Extension Additional content defined by implementations
....... url 1..1 uri "status"
....... value[x] N 1..1 Coding Value of extension
Binding: PublicationStatus (required)
........ system ΣN 1..1 uri Identity of the terminology system
........ code ΣN 1..1 code Symbol in syntax defined by the system
..... url 1..1 uri "http://fhir.de/ConsentManagement/StructureDefinition/DomainReference"
.... extension:externalProperty S 0..* (Complex) ExternalProperty
URL: https://ths-greifswald.de/fhir/StructureDefinition/gics/ExternalProperty
.... extension:expirationProperty S 0..* (Complex) Expiration Property
URL: https://ths-greifswald.de/fhir/StructureDefinition/gics/ExpirationProperty
... status ?!SΣ 1..1 code draft | proposed | active | rejected | inactive | entered-in-error
Binding: ConsentState (required): Indicates the state of the consent.
... scope ?!Σ 1..1 CodeableConcept Which of the four areas this resource covers (extensible)
Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource.
... Slices for category SΣN 1..* CodeableConcept Classification of the consent statement - for indexing/retrieval
Slice: Unordered, Open by pattern:$this
Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement.
.... category:consentCategory SΣ 1..* CodeableConcept Classification of the consent statement - for indexing/retrieval
Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement.
..... coding SΣ 1..1 Coding Code defined by a terminology system
...... system SΣ 1..1 uri Identity of the terminology system
...... code SΣ 1..1 code Symbol in syntax defined by the system
.... category:resultType SΣ 0..* CodeableConcept Classification of the consent statement - for indexing/retrieval
Binding: ConsentManagementResultType (required): A classification of the type of consents found in a consent statement.
..... coding SΣ 1..1 Coding Code defined by a terminology system
...... system SΣ 1..1 uri Identity of the terminology system
...... code SΣ 1..1 code Symbol in syntax defined by the system
.... category:templateType SΣN 0..* CodeableConcept Classification of the consent statement - for indexing/retrieval
Binding: ConsentManagementTemplateType (extensible): A classification of the type of consents found in a consent statement.
..... coding SΣN 1..* Coding Code defined by a terminology system
...... system SΣN 1..1 uri Identity of the terminology system
...... code SΣN 1..1 code Symbol in syntax defined by the system
... patient SΣC 1..1 Reference(Consent Management: Patient(2.0.2)) Who the consent applies to
Constraints: ref-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
... dateTime SΣ 1..1 dateTime Erstellungszeitpunkt der Einwilligungsinformation
... organization SΣC 0..* Reference(Organization) Organisation, in der die Einwilligung erfasst wurde.
Constraints: ref-1
... source[x] SΣ 0..1 Reference(Consent Management QuestionnaireResponse(2.0.2)) Source from which this consent is taken
.... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
... policy S 0..* BackboneElement Policies covered by this consent
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... authority C 0..1 uri Enforcement source for policy
.... uri SC 1..1 uri Specific policy covered by this consent
... policyRule SΣC 0..1 CodeableConcept Regulation that this consents to
Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples.
.... Slices for extension Content/Rules for all slices
..... extension:xacml SN 0..1 base64Binary Optional Extensions Element
URL: http://fhir.de/ConsentManagement/StructureDefinition/Xacml
... provision SΣ 0..1 BackboneElement Constraints to the base Consent.policyRule
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... period SΣC 0..1 Period Timeframe for this rule
Constraints: per-1

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Consent.extension:domainReference.​extension:status.value[x] Base required PublicationStatus 📦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.category:consentCategory Base extensible Consent Category Codes 📦4.0.1 FHIR Std.
Consent.category:resultType Base required ConsentManagementResultType 📦2.0.2 de.einwilligungsmanagement v2.0
Consent.category:templateType Base extensible ConsentManagementTemplateType 📦2.0.2 de.einwilligungsmanagement v2.0
Consent.policyRule Base extensible Consent PolicyRule Codes 📦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** elements Must have either extensions or value[x], not both extension.exists() != value.exists()
per-1 error Consent.provision.period If present, start SHALL have a lower value than end start.hasValue().not() or end.hasValue().not() or (start <= end)
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()
ref-1 error Consent.patient, Consent.organization SHALL have a contained resource if a local reference is provided reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

This structure is derived from ConsentManagementConsent

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Consent 0..* ConsentManagementConsent(2.0.2) A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
... meta
.... Slices for extension Content/Rules for all slices
..... extension:created S 0..1 instant Created
URL: https://ths-greifswald.de/fhir/StructureDefinition/gics/Created
.... lastUpdated S 0..1 instant When the resource version last changed
... Slices for extension Content/Rules for all slices
.... extension:externalProperty S 0..* (Complex) ExternalProperty
URL: https://ths-greifswald.de/fhir/StructureDefinition/gics/ExternalProperty
.... extension:expirationProperty S 0..* (Complex) Expiration Property
URL: https://ths-greifswald.de/fhir/StructureDefinition/gics/ExpirationProperty
... Slices for category Content/Rules for all slices
.... category:consentCategory 1..* CodeableConcept Classification of the consent statement - for indexing/retrieval
..... coding 1..1 Coding Code defined by a terminology system
.... category:resultType 0..* CodeableConcept Classification of the consent statement - for indexing/retrieval
..... coding 1..1 Coding Code defined by a terminology system

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Consent C 0..* ConsentManagementConsent(2.0.2) A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
Constraints: ppc-4, ppc-5, ppc-2, ppc-3, ppc-1
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:created S 0..1 instant Created
URL: https://ths-greifswald.de/fhir/StructureDefinition/gics/Created
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated SΣ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... 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
... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... extension:domainReference SN 0..* (Complex) Optional Extensions Element
URL: http://fhir.de/ConsentManagement/StructureDefinition/DomainReference
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:domain SN 1..1 Extension Additional content defined by implementations
....... id 0..1 string Unique id for inter-element referencing
....... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1 uri "domain"
....... value[x] N 1..1 Reference(Consent Management Domain Organization(2.0.2) | Consent Management Domain Research Study(2.0.2)) Value of extension
...... extension:status N 0..1 Extension Additional content defined by implementations
....... id 0..1 string Unique id for inter-element referencing
....... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1 uri "status"
....... value[x] N 1..1 Coding Value of extension
Binding: PublicationStatus (required)
........ id 0..1 string Unique id for inter-element referencing
........ extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ system ΣN 1..1 uri Identity of the terminology system
........ version ΣN 0..1 string Version of the system - if relevant
........ code ΣN 1..1 code Symbol in syntax defined by the system
........ display ΣN 0..1 string Representation defined by the system
........ userSelected ΣN 0..1 boolean If this coding was chosen directly by the user
..... url 1..1 uri "http://fhir.de/ConsentManagement/StructureDefinition/DomainReference"
.... extension:externalProperty S 0..* (Complex) ExternalProperty
URL: https://ths-greifswald.de/fhir/StructureDefinition/gics/ExternalProperty
.... extension:expirationProperty S 0..* (Complex) Expiration Property
URL: https://ths-greifswald.de/fhir/StructureDefinition/gics/ExpirationProperty
... modifierExtension ?!N 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... identifier Σ 0..* Identifier Identifier for this record (external references)

Example General: {"system":"urn:ietf:rfc:3986","value":"Local eCMS identifier"}
... status ?!SΣ 1..1 code draft | proposed | active | rejected | inactive | entered-in-error
Binding: ConsentState (required): Indicates the state of the consent.
... scope ?!Σ 1..1 CodeableConcept Which of the four areas this resource covers (extensible)
Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource.
... Slices for category SΣN 1..* CodeableConcept Classification of the consent statement - for indexing/retrieval
Slice: Unordered, Open by pattern:$this
Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement.
.... category:consentCategory SΣ 1..* CodeableConcept Classification of the consent statement - for indexing/retrieval
Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement.
..... id 0..1 string Unique id for inter-element referencing
..... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding SΣ 1..1 Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 1..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... 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:resultType SΣ 0..* CodeableConcept Classification of the consent statement - for indexing/retrieval
Binding: ConsentManagementResultType (required): A classification of the type of consents found in a consent statement.
..... id 0..1 string Unique id for inter-element referencing
..... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding SΣ 1..1 Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 1..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... 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:templateType SΣN 0..* CodeableConcept Classification of the consent statement - for indexing/retrieval
Binding: ConsentManagementTemplateType (extensible): A classification of the type of consents found in a consent statement.
..... id 0..1 string Unique id for inter-element referencing
..... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding SΣN 1..* Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣN 1..1 uri Identity of the terminology system
...... version ΣN 0..1 string Version of the system - if relevant
...... code SΣN 1..1 code Symbol in syntax defined by the system
...... display ΣN 0..1 string Representation defined by the system
...... userSelected ΣN 0..1 boolean If this coding was chosen directly by the user
..... text ΣN 0..1 string Plain text representation of the concept
... patient SΣC 1..1 Reference(Consent Management: Patient(2.0.2)) Who the consent applies to
Constraints: ref-1
.... id 0..1 string Unique id for inter-element referencing
.... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... dateTime SΣ 1..1 dateTime Erstellungszeitpunkt der Einwilligungsinformation
... performer ΣC 0..* Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) Who is agreeing to the policy and rules
Constraints: ref-1
... organization SΣC 0..* Reference(Organization) Organisation, in der die Einwilligung erfasst wurde.
Constraints: ref-1
... source[x] SΣ 0..1 Reference(Consent Management QuestionnaireResponse(2.0.2)) Source from which this consent is taken
.... id 0..1 string Unique id for inter-element referencing
.... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... policy S 0..* BackboneElement Policies covered by this consent
.... id 0..1 string Unique id for inter-element referencing
.... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... authority C 0..1 uri Enforcement source for policy
.... uri SC 1..1 uri Specific policy covered by this consent
... policyRule SΣC 0..1 CodeableConcept Regulation that this consents to
Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples.
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:xacml SN 0..1 base64Binary Optional Extensions Element
URL: http://fhir.de/ConsentManagement/StructureDefinition/Xacml
.... coding Σ 0..* Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... verification Σ 0..* BackboneElement Consent Verified by patient or family
.... id 0..1 string Unique id for inter-element referencing
.... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... verified Σ 1..1 boolean Has been verified
.... verifiedWith C 0..1 Reference(Patient | RelatedPerson) Person who verified
Constraints: ref-1
.... verificationDate 0..1 dateTime When consent verified
... provision SΣ 0..1 BackboneElement Constraints to the base Consent.policyRule
.... id 0..1 string Unique id for inter-element referencing
.... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type Σ 0..1 code deny | permit
Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent.
.... period SΣC 0..1 Period Timeframe for this rule
Constraints: per-1
.... actor 0..* BackboneElement Who|what controlled by this rule (or group, by role)
..... id 0..1 string Unique id for inter-element referencing
..... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... role 1..1 CodeableConcept How the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.
..... reference C 1..1 Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) Resource for the actor (or group, by role)
Constraints: ref-1
.... action Σ 0..* CodeableConcept Actions controlled by this rule
Binding: ConsentActionCodes (example): Detailed codes for the consent action.
.... securityLabel Σ 0..* Coding Security Labels that define affected resources
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... purpose Σ 0..* Coding Context of activities covered by this rule
Binding: PurposeOfUse (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels.
.... class Σ 0..* Coding e.g. Resource Type, Profile, CDA, etc.
Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers.
.... code Σ 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 ΣC 0..1 Period Timeframe for data controlled by this rule
Constraints: per-1
.... data Σ 0..* BackboneElement Data controlled by this rule
..... id 0..1 string Unique id for inter-element referencing
..... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... 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 ΣC 1..1 Reference(Resource) The actual data reference
Constraints: ref-1
.... provision 0..* See provision (Consent) Nested Exception Rules

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Consent.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Consent.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Consent.language Base preferred Common Languages 📦4.0.1 FHIR Std.
Consent.extension:domainReference.​extension:status.value[x] Base required PublicationStatus 📦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.category:consentCategory Base extensible Consent Category Codes 📦4.0.1 FHIR Std.
Consent.category:resultType Base required ConsentManagementResultType 📦2.0.2 de.einwilligungsmanagement v2.0
Consent.category:templateType Base extensible ConsentManagementTemplateType 📦2.0.2 de.einwilligungsmanagement v2.0
Consent.patient.type Base extensible ResourceType 📦4.0.1 FHIR Std.
Consent.source[x].type Base extensible ResourceType 📦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** elements Must have either extensions or value[x], not both extension.exists() != value.exists()
per-1 error Consent.provision.period, Consent.provision.dataPeriod If present, start SHALL have a lower value than end start.hasValue().not() or end.hasValue().not() or (start <= end)
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()
ref-1 error Consent.patient, Consent.performer, Consent.organization, Consent.verification.verifiedWith, Consent.provision.actor.reference, Consent.provision.data.reference SHALL have a contained resource if a local reference is provided reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Consent C 0..* ConsentManagementConsent(2.0.2) A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
Constraints: ppc-4, ppc-5, ppc-2, ppc-3, ppc-1
... meta Σ 0..1 Meta Metadata about the resource
.... Slices for extension Content/Rules for all slices
..... extension:created S 0..1 instant Created
URL: https://ths-greifswald.de/fhir/StructureDefinition/gics/Created
.... lastUpdated SΣ 0..1 instant When the resource version last changed
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... extension:domainReference SN 0..* (Complex) Optional Extensions Element
URL: http://fhir.de/ConsentManagement/StructureDefinition/DomainReference
..... Slices for extension Content/Rules for all slices
...... extension:domain SN 1..1 Extension Additional content defined by implementations
....... url 1..1 uri "domain"
....... value[x] N 1..1 Reference(Consent Management Domain Organization(2.0.2) | Consent Management Domain Research Study(2.0.2)) Value of extension
...... extension:status N 0..1 Extension Additional content defined by implementations
....... url 1..1 uri "status"
....... value[x] N 1..1 Coding Value of extension
Binding: PublicationStatus (required)
........ system ΣN 1..1 uri Identity of the terminology system
........ code ΣN 1..1 code Symbol in syntax defined by the system
..... url 1..1 uri "http://fhir.de/ConsentManagement/StructureDefinition/DomainReference"
.... extension:externalProperty S 0..* (Complex) ExternalProperty
URL: https://ths-greifswald.de/fhir/StructureDefinition/gics/ExternalProperty
.... extension:expirationProperty S 0..* (Complex) Expiration Property
URL: https://ths-greifswald.de/fhir/StructureDefinition/gics/ExpirationProperty
... status ?!SΣ 1..1 code draft | proposed | active | rejected | inactive | entered-in-error
Binding: ConsentState (required): Indicates the state of the consent.
... scope ?!Σ 1..1 CodeableConcept Which of the four areas this resource covers (extensible)
Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource.
... Slices for category SΣN 1..* CodeableConcept Classification of the consent statement - for indexing/retrieval
Slice: Unordered, Open by pattern:$this
Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement.
.... category:consentCategory SΣ 1..* CodeableConcept Classification of the consent statement - for indexing/retrieval
Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement.
..... coding SΣ 1..1 Coding Code defined by a terminology system
...... system SΣ 1..1 uri Identity of the terminology system
...... code SΣ 1..1 code Symbol in syntax defined by the system
.... category:resultType SΣ 0..* CodeableConcept Classification of the consent statement - for indexing/retrieval
Binding: ConsentManagementResultType (required): A classification of the type of consents found in a consent statement.
..... coding SΣ 1..1 Coding Code defined by a terminology system
...... system SΣ 1..1 uri Identity of the terminology system
...... code SΣ 1..1 code Symbol in syntax defined by the system
.... category:templateType SΣN 0..* CodeableConcept Classification of the consent statement - for indexing/retrieval
Binding: ConsentManagementTemplateType (extensible): A classification of the type of consents found in a consent statement.
..... coding SΣN 1..* Coding Code defined by a terminology system
...... system SΣN 1..1 uri Identity of the terminology system
...... code SΣN 1..1 code Symbol in syntax defined by the system
... patient SΣC 1..1 Reference(Consent Management: Patient(2.0.2)) Who the consent applies to
Constraints: ref-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
... dateTime SΣ 1..1 dateTime Erstellungszeitpunkt der Einwilligungsinformation
... organization SΣC 0..* Reference(Organization) Organisation, in der die Einwilligung erfasst wurde.
Constraints: ref-1
... source[x] SΣ 0..1 Reference(Consent Management QuestionnaireResponse(2.0.2)) Source from which this consent is taken
.... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
... policy S 0..* BackboneElement Policies covered by this consent
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... authority C 0..1 uri Enforcement source for policy
.... uri SC 1..1 uri Specific policy covered by this consent
... policyRule SΣC 0..1 CodeableConcept Regulation that this consents to
Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples.
.... Slices for extension Content/Rules for all slices
..... extension:xacml SN 0..1 base64Binary Optional Extensions Element
URL: http://fhir.de/ConsentManagement/StructureDefinition/Xacml
... provision SΣ 0..1 BackboneElement Constraints to the base Consent.policyRule
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... period SΣC 0..1 Period Timeframe for this rule
Constraints: per-1

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Consent.extension:domainReference.​extension:status.value[x] Base required PublicationStatus 📦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.category:consentCategory Base extensible Consent Category Codes 📦4.0.1 FHIR Std.
Consent.category:resultType Base required ConsentManagementResultType 📦2.0.2 de.einwilligungsmanagement v2.0
Consent.category:templateType Base extensible ConsentManagementTemplateType 📦2.0.2 de.einwilligungsmanagement v2.0
Consent.policyRule Base extensible Consent PolicyRule Codes 📦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** elements Must have either extensions or value[x], not both extension.exists() != value.exists()
per-1 error Consent.provision.period If present, start SHALL have a lower value than end start.hasValue().not() or end.hasValue().not() or (start <= end)
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()
ref-1 error Consent.patient, Consent.organization SHALL have a contained resource if a local reference is provided reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Differential View

This structure is derived from ConsentManagementConsent

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Consent 0..* ConsentManagementConsent(2.0.2) A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
... meta
.... Slices for extension Content/Rules for all slices
..... extension:created S 0..1 instant Created
URL: https://ths-greifswald.de/fhir/StructureDefinition/gics/Created
.... lastUpdated S 0..1 instant When the resource version last changed
... Slices for extension Content/Rules for all slices
.... extension:externalProperty S 0..* (Complex) ExternalProperty
URL: https://ths-greifswald.de/fhir/StructureDefinition/gics/ExternalProperty
.... extension:expirationProperty S 0..* (Complex) Expiration Property
URL: https://ths-greifswald.de/fhir/StructureDefinition/gics/ExpirationProperty
... Slices for category Content/Rules for all slices
.... category:consentCategory 1..* CodeableConcept Classification of the consent statement - for indexing/retrieval
..... coding 1..1 Coding Code defined by a terminology system
.... category:resultType 0..* CodeableConcept Classification of the consent statement - for indexing/retrieval
..... coding 1..1 Coding Code defined by a terminology system

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Consent C 0..* ConsentManagementConsent(2.0.2) A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
Constraints: ppc-4, ppc-5, ppc-2, ppc-3, ppc-1
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:created S 0..1 instant Created
URL: https://ths-greifswald.de/fhir/StructureDefinition/gics/Created
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated SΣ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... 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
... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... extension:domainReference SN 0..* (Complex) Optional Extensions Element
URL: http://fhir.de/ConsentManagement/StructureDefinition/DomainReference
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:domain SN 1..1 Extension Additional content defined by implementations
....... id 0..1 string Unique id for inter-element referencing
....... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1 uri "domain"
....... value[x] N 1..1 Reference(Consent Management Domain Organization(2.0.2) | Consent Management Domain Research Study(2.0.2)) Value of extension
...... extension:status N 0..1 Extension Additional content defined by implementations
....... id 0..1 string Unique id for inter-element referencing
....... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1 uri "status"
....... value[x] N 1..1 Coding Value of extension
Binding: PublicationStatus (required)
........ id 0..1 string Unique id for inter-element referencing
........ extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ system ΣN 1..1 uri Identity of the terminology system
........ version ΣN 0..1 string Version of the system - if relevant
........ code ΣN 1..1 code Symbol in syntax defined by the system
........ display ΣN 0..1 string Representation defined by the system
........ userSelected ΣN 0..1 boolean If this coding was chosen directly by the user
..... url 1..1 uri "http://fhir.de/ConsentManagement/StructureDefinition/DomainReference"
.... extension:externalProperty S 0..* (Complex) ExternalProperty
URL: https://ths-greifswald.de/fhir/StructureDefinition/gics/ExternalProperty
.... extension:expirationProperty S 0..* (Complex) Expiration Property
URL: https://ths-greifswald.de/fhir/StructureDefinition/gics/ExpirationProperty
... modifierExtension ?!N 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... identifier Σ 0..* Identifier Identifier for this record (external references)

Example General: {"system":"urn:ietf:rfc:3986","value":"Local eCMS identifier"}
... status ?!SΣ 1..1 code draft | proposed | active | rejected | inactive | entered-in-error
Binding: ConsentState (required): Indicates the state of the consent.
... scope ?!Σ 1..1 CodeableConcept Which of the four areas this resource covers (extensible)
Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource.
... Slices for category SΣN 1..* CodeableConcept Classification of the consent statement - for indexing/retrieval
Slice: Unordered, Open by pattern:$this
Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement.
.... category:consentCategory SΣ 1..* CodeableConcept Classification of the consent statement - for indexing/retrieval
Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement.
..... id 0..1 string Unique id for inter-element referencing
..... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding SΣ 1..1 Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 1..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... 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:resultType SΣ 0..* CodeableConcept Classification of the consent statement - for indexing/retrieval
Binding: ConsentManagementResultType (required): A classification of the type of consents found in a consent statement.
..... id 0..1 string Unique id for inter-element referencing
..... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding SΣ 1..1 Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 1..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... 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:templateType SΣN 0..* CodeableConcept Classification of the consent statement - for indexing/retrieval
Binding: ConsentManagementTemplateType (extensible): A classification of the type of consents found in a consent statement.
..... id 0..1 string Unique id for inter-element referencing
..... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding SΣN 1..* Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣN 1..1 uri Identity of the terminology system
...... version ΣN 0..1 string Version of the system - if relevant
...... code SΣN 1..1 code Symbol in syntax defined by the system
...... display ΣN 0..1 string Representation defined by the system
...... userSelected ΣN 0..1 boolean If this coding was chosen directly by the user
..... text ΣN 0..1 string Plain text representation of the concept
... patient SΣC 1..1 Reference(Consent Management: Patient(2.0.2)) Who the consent applies to
Constraints: ref-1
.... id 0..1 string Unique id for inter-element referencing
.... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... dateTime SΣ 1..1 dateTime Erstellungszeitpunkt der Einwilligungsinformation
... performer ΣC 0..* Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) Who is agreeing to the policy and rules
Constraints: ref-1
... organization SΣC 0..* Reference(Organization) Organisation, in der die Einwilligung erfasst wurde.
Constraints: ref-1
... source[x] SΣ 0..1 Reference(Consent Management QuestionnaireResponse(2.0.2)) Source from which this consent is taken
.... id 0..1 string Unique id for inter-element referencing
.... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... policy S 0..* BackboneElement Policies covered by this consent
.... id 0..1 string Unique id for inter-element referencing
.... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... authority C 0..1 uri Enforcement source for policy
.... uri SC 1..1 uri Specific policy covered by this consent
... policyRule SΣC 0..1 CodeableConcept Regulation that this consents to
Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples.
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:xacml SN 0..1 base64Binary Optional Extensions Element
URL: http://fhir.de/ConsentManagement/StructureDefinition/Xacml
.... coding Σ 0..* Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... verification Σ 0..* BackboneElement Consent Verified by patient or family
.... id 0..1 string Unique id for inter-element referencing
.... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... verified Σ 1..1 boolean Has been verified
.... verifiedWith C 0..1 Reference(Patient | RelatedPerson) Person who verified
Constraints: ref-1
.... verificationDate 0..1 dateTime When consent verified
... provision SΣ 0..1 BackboneElement Constraints to the base Consent.policyRule
.... id 0..1 string Unique id for inter-element referencing
.... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type Σ 0..1 code deny | permit
Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent.
.... period SΣC 0..1 Period Timeframe for this rule
Constraints: per-1
.... actor 0..* BackboneElement Who|what controlled by this rule (or group, by role)
..... id 0..1 string Unique id for inter-element referencing
..... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... role 1..1 CodeableConcept How the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.
..... reference C 1..1 Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) Resource for the actor (or group, by role)
Constraints: ref-1
.... action Σ 0..* CodeableConcept Actions controlled by this rule
Binding: ConsentActionCodes (example): Detailed codes for the consent action.
.... securityLabel Σ 0..* Coding Security Labels that define affected resources
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... purpose Σ 0..* Coding Context of activities covered by this rule
Binding: PurposeOfUse (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels.
.... class Σ 0..* Coding e.g. Resource Type, Profile, CDA, etc.
Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers.
.... code Σ 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 ΣC 0..1 Period Timeframe for data controlled by this rule
Constraints: per-1
.... data Σ 0..* BackboneElement Data controlled by this rule
..... id 0..1 string Unique id for inter-element referencing
..... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... 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 ΣC 1..1 Reference(Resource) The actual data reference
Constraints: ref-1
.... provision 0..* See provision (Consent) Nested Exception Rules

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Consent.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Consent.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Consent.language Base preferred Common Languages 📦4.0.1 FHIR Std.
Consent.extension:domainReference.​extension:status.value[x] Base required PublicationStatus 📦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.category:consentCategory Base extensible Consent Category Codes 📦4.0.1 FHIR Std.
Consent.category:resultType Base required ConsentManagementResultType 📦2.0.2 de.einwilligungsmanagement v2.0
Consent.category:templateType Base extensible ConsentManagementTemplateType 📦2.0.2 de.einwilligungsmanagement v2.0
Consent.patient.type Base extensible ResourceType 📦4.0.1 FHIR Std.
Consent.source[x].type Base extensible ResourceType 📦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** elements Must have either extensions or value[x], not both extension.exists() != value.exists()
per-1 error Consent.provision.period, Consent.provision.dataPeriod If present, start SHALL have a lower value than end start.hasValue().not() or end.hasValue().not() or (start <= end)
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()
ref-1 error Consent.patient, Consent.performer, Consent.organization, Consent.verification.verifiedWith, Consent.provision.actor.reference, Consent.provision.data.reference SHALL have a contained resource if a local reference is provided reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

 

Other representations of profile: CSV, Excel, Schematron