Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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: dom-2, dom-3, dom-4, dom-5, dom-6, ppc-4, ppc-5, ppc-2, ppc-3, ppc-1
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored Slice: Unordered, Open by value:url
status	?!Σ	1..1	code	draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent. Fixed Value: active
scope	?!Σ	1..1	CodeableConcept	Which of the four areas this resource covers (extensible) Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource.
coding	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	Σ	0..1	code	Symbol in syntax defined by the system Fixed Value: patient-privacy
display	Σ	0..1	string	Representation defined by the system Fixed Value: Privacy Consent
category	SΣ	1..1	CodeableConcept	Classification of the consent statement - for indexing/retrieval Binding: ValueSet of Consent Codes (required)
patient	SΣC	1..1	Reference(Patient)	Who the consent applies to Constraints: ref-1
identifier	SΣ	1..1	IdentifierKvid10	Logical reference, when literal reference is not known
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	ΣC	0..1	CodeableConcept	Description of identifier Binding: Identifier Type DeBasis ValueSet (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Constraints: kvid-2 Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://fhir.de/CodeSystem/identifier-type-de-basis
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: KVZ10
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
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: http://fhir.de/sid/gkv/kvid-10
value	ΣC	1..1	string	The value that is unique Constraints: kvid-1 Example General: 123456
assigner	SΣ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier	SΣ	0..1	IdentifierIknr	Logical reference, when literal reference is not known
dateTime	SΣ	0..1	dateTime	When this Consent was created or indexed
policyRule	SΣC	0..1	CodeableConcept	Regulation that this consents to Binding: v3 Code System ActCode (required)
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	required	ValueSet of Consent Codes	📦2.0.0-ballot.1	This IG
Consent.patient.identifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Consent.patient.identifier.​type	Base	extensible	Identifier Type DeBasis ValueSet	📦1.5.4	de.basisprofil.r4 v1.5
Consent.policyRule	Base	required	v3 Code System ActCode	📦3.0.0	THO v7.1

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()
kvid-1	warning	Consent.patient.identifier.value	Der unveränderliche Teil der KVID muss 10-stellig sein und mit einem Großbuchstaben anfangen	matches('^[A-Z][0-9]{9}$')
kvid-2	warning	Consent.patient.identifier.type	Die type Codes 'GKV' und 'PKV' haben den Status 'retired', daher sollen diese nicht mehr verwendet werden	($this.coding.exists(system='http://fhir.de/CodeSystem/identifier-type-de-basis' and code='GKV') or $this.coding.exists(system='http://fhir.de/CodeSystem/identifier-type-de-basis' and code='PKV')).not()
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	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'))

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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
status		1..1	code	draft | proposed | active | rejected | inactive | entered-in-error Fixed Value: active
scope
coding	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		0..1	code	Symbol in syntax defined by the system Fixed Value: patient-privacy
display		0..1	string	Representation defined by the system Fixed Value: Privacy Consent
category	S	1..1	CodeableConcept	Classification of the consent statement - for indexing/retrieval Binding: ValueSet of Consent Codes (required)
patient	S	1..1	Reference(Patient)	Who the consent applies to
identifier	S	1..1	IdentifierKvid10	Logical reference, when literal reference is not known
assigner	S	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier	S	0..1	IdentifierIknr	Logical reference, when literal reference is not known
dateTime	S	0..1	dateTime	When this Consent was created or indexed
policyRule	S	0..1	CodeableConcept	Regulation that this consents to Binding: v3 Code System ActCode (required)
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Consent.category	Base	required	ValueSet of Consent Codes	📦2.0.0-ballot.1	This IG
Consent.policyRule	Base	required	v3 Code System ActCode	📦3.0.0	THO v7.1

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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: dom-2, dom-3, dom-4, dom-5, dom-6, 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
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 Bindings Purpose 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 Slice: Unordered, Open by value:url
modifierExtension	?!	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":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"}
status	?!Σ	1..1	code	draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent. Fixed Value: active
scope	?!Σ	1..1	CodeableConcept	Which of the four areas this resource covers (extensible) Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource.
id		0..1	string	Unique id for inter-element referencing
extension		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		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	Σ	0..1	code	Symbol in syntax defined by the system Fixed Value: patient-privacy
display	Σ	0..1	string	Representation defined by the system Fixed Value: Privacy Consent
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..1	CodeableConcept	Classification of the consent statement - for indexing/retrieval Binding: ValueSet of Consent Codes (required)
patient	SΣC	1..1	Reference(Patient)	Who the consent applies to Constraints: ref-1
id		0..1	string	Unique id for inter-element referencing
extension		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	SΣ	1..1	IdentifierKvid10	Logical reference, when literal reference is not known
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	ΣC	0..1	CodeableConcept	Description of identifier Binding: Identifier Type DeBasis ValueSet (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Constraints: kvid-2 Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://fhir.de/CodeSystem/identifier-type-de-basis
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: KVZ10
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
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: http://fhir.de/sid/gkv/kvid-10
value	ΣC	1..1	string	The value that is unique Constraints: kvid-1 Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	SΣ	0..1	Reference(Organization)	Organization that issued id (may be just text)
id		0..1	string	Unique id for inter-element referencing
extension		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	SΣ	0..1	IdentifierIknr	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
display	Σ	0..1	string	Text alternative for the resource
dateTime	SΣ	0..1	dateTime	When this Consent was created or indexed
performer	ΣC	0..*	Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole)	Who is agreeing to the policy and rules Constraints: ref-1
organization	ΣC	0..*	Reference(Organization)	Custodian of the consent Constraints: ref-1
source[x]	Σ	0..1		Source from which this consent is taken
sourceAttachment			Attachment
sourceReference			Reference(Consent | DocumentReference | Contract | QuestionnaireResponse)
policy		0..*	BackboneElement	Policies covered by this consent
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations 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	C	0..1	uri	Specific policy covered by this consent
policyRule	SΣC	0..1	CodeableConcept	Regulation that this consents to Binding: v3 Code System ActCode (required)
verification	Σ	0..*	BackboneElement	Consent Verified by patient or family
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations 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	Σ	0..1	BackboneElement	Constraints to the base Consent.policyRule
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations 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	Σ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		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		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
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	required	ValueSet of Consent Codes	📦2.0.0-ballot.1	This IG
Consent.patient.type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Consent.patient.identifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Consent.patient.identifier.​type	Base	extensible	Identifier Type DeBasis ValueSet	📦1.5.4	de.basisprofil.r4 v1.5
Consent.patient.identifier.​assigner.type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Consent.policyRule	Base	required	v3 Code System ActCode	📦3.0.0	THO v7.1
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.1
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()
kvid-1	warning	Consent.patient.identifier.value	Der unveränderliche Teil der KVID muss 10-stellig sein und mit einem Großbuchstaben anfangen	matches('^[A-Z][0-9]{9}$')
kvid-2	warning	Consent.patient.identifier.type	Die type Codes 'GKV' und 'PKV' haben den Status 'retired', daher sollen diese nicht mehr verwendet werden	($this.coding.exists(system='http://fhir.de/CodeSystem/identifier-type-de-basis' and code='GKV') or $this.coding.exists(system='http://fhir.de/CodeSystem/identifier-type-de-basis' and code='PKV')).not()
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'))

Summary

Mandatory: 3 elements
Must-Support: 8 elements
Fixed: 4 elements

Structures

This structure refers to these other structures:

• Identifier-Profil für die 10-stellige Krankenversichertennummer (http://fhir.de/StructureDefinition/identifier-kvid-10)
• Identifier-Profil für die Abbildung eines Institutionskennzeichens (IKNR) (http://fhir.de/StructureDefinition/identifier-iknr)

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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: dom-2, dom-3, dom-4, dom-5, dom-6, ppc-4, ppc-5, ppc-2, ppc-3, ppc-1
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored Slice: Unordered, Open by value:url
status	?!Σ	1..1	code	draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent. Fixed Value: active
scope	?!Σ	1..1	CodeableConcept	Which of the four areas this resource covers (extensible) Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource.
coding	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	Σ	0..1	code	Symbol in syntax defined by the system Fixed Value: patient-privacy
display	Σ	0..1	string	Representation defined by the system Fixed Value: Privacy Consent
category	SΣ	1..1	CodeableConcept	Classification of the consent statement - for indexing/retrieval Binding: ValueSet of Consent Codes (required)
patient	SΣC	1..1	Reference(Patient)	Who the consent applies to Constraints: ref-1
identifier	SΣ	1..1	IdentifierKvid10	Logical reference, when literal reference is not known
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	ΣC	0..1	CodeableConcept	Description of identifier Binding: Identifier Type DeBasis ValueSet (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Constraints: kvid-2 Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://fhir.de/CodeSystem/identifier-type-de-basis
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: KVZ10
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
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: http://fhir.de/sid/gkv/kvid-10
value	ΣC	1..1	string	The value that is unique Constraints: kvid-1 Example General: 123456
assigner	SΣ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier	SΣ	0..1	IdentifierIknr	Logical reference, when literal reference is not known
dateTime	SΣ	0..1	dateTime	When this Consent was created or indexed
policyRule	SΣC	0..1	CodeableConcept	Regulation that this consents to Binding: v3 Code System ActCode (required)
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	required	ValueSet of Consent Codes	📦2.0.0-ballot.1	This IG
Consent.patient.identifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Consent.patient.identifier.​type	Base	extensible	Identifier Type DeBasis ValueSet	📦1.5.4	de.basisprofil.r4 v1.5
Consent.policyRule	Base	required	v3 Code System ActCode	📦3.0.0	THO v7.1

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()
kvid-1	warning	Consent.patient.identifier.value	Der unveränderliche Teil der KVID muss 10-stellig sein und mit einem Großbuchstaben anfangen	matches('^[A-Z][0-9]{9}$')
kvid-2	warning	Consent.patient.identifier.type	Die type Codes 'GKV' und 'PKV' haben den Status 'retired', daher sollen diese nicht mehr verwendet werden	($this.coding.exists(system='http://fhir.de/CodeSystem/identifier-type-de-basis' and code='GKV') or $this.coding.exists(system='http://fhir.de/CodeSystem/identifier-type-de-basis' and code='PKV')).not()
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	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'))

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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
status		1..1	code	draft | proposed | active | rejected | inactive | entered-in-error Fixed Value: active
scope
coding	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		0..1	code	Symbol in syntax defined by the system Fixed Value: patient-privacy
display		0..1	string	Representation defined by the system Fixed Value: Privacy Consent
category	S	1..1	CodeableConcept	Classification of the consent statement - for indexing/retrieval Binding: ValueSet of Consent Codes (required)
patient	S	1..1	Reference(Patient)	Who the consent applies to
identifier	S	1..1	IdentifierKvid10	Logical reference, when literal reference is not known
assigner	S	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier	S	0..1	IdentifierIknr	Logical reference, when literal reference is not known
dateTime	S	0..1	dateTime	When this Consent was created or indexed
policyRule	S	0..1	CodeableConcept	Regulation that this consents to Binding: v3 Code System ActCode (required)
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Consent.category	Base	required	ValueSet of Consent Codes	📦2.0.0-ballot.1	This IG
Consent.policyRule	Base	required	v3 Code System ActCode	📦3.0.0	THO v7.1

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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: dom-2, dom-3, dom-4, dom-5, dom-6, 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
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 Bindings Purpose 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 Slice: Unordered, Open by value:url
modifierExtension	?!	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":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"}
status	?!Σ	1..1	code	draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent. Fixed Value: active
scope	?!Σ	1..1	CodeableConcept	Which of the four areas this resource covers (extensible) Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource.
id		0..1	string	Unique id for inter-element referencing
extension		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		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	Σ	0..1	code	Symbol in syntax defined by the system Fixed Value: patient-privacy
display	Σ	0..1	string	Representation defined by the system Fixed Value: Privacy Consent
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..1	CodeableConcept	Classification of the consent statement - for indexing/retrieval Binding: ValueSet of Consent Codes (required)
patient	SΣC	1..1	Reference(Patient)	Who the consent applies to Constraints: ref-1
id		0..1	string	Unique id for inter-element referencing
extension		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	SΣ	1..1	IdentifierKvid10	Logical reference, when literal reference is not known
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	ΣC	0..1	CodeableConcept	Description of identifier Binding: Identifier Type DeBasis ValueSet (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Constraints: kvid-2 Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://fhir.de/CodeSystem/identifier-type-de-basis
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: KVZ10
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
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: http://fhir.de/sid/gkv/kvid-10
value	ΣC	1..1	string	The value that is unique Constraints: kvid-1 Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	SΣ	0..1	Reference(Organization)	Organization that issued id (may be just text)
id		0..1	string	Unique id for inter-element referencing
extension		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	SΣ	0..1	IdentifierIknr	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
display	Σ	0..1	string	Text alternative for the resource
dateTime	SΣ	0..1	dateTime	When this Consent was created or indexed
performer	ΣC	0..*	Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole)	Who is agreeing to the policy and rules Constraints: ref-1
organization	ΣC	0..*	Reference(Organization)	Custodian of the consent Constraints: ref-1
source[x]	Σ	0..1		Source from which this consent is taken
sourceAttachment			Attachment
sourceReference			Reference(Consent | DocumentReference | Contract | QuestionnaireResponse)
policy		0..*	BackboneElement	Policies covered by this consent
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations 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	C	0..1	uri	Specific policy covered by this consent
policyRule	SΣC	0..1	CodeableConcept	Regulation that this consents to Binding: v3 Code System ActCode (required)
verification	Σ	0..*	BackboneElement	Consent Verified by patient or family
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations 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	Σ	0..1	BackboneElement	Constraints to the base Consent.policyRule
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations 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	Σ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		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		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
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	required	ValueSet of Consent Codes	📦2.0.0-ballot.1	This IG
Consent.patient.type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Consent.patient.identifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Consent.patient.identifier.​type	Base	extensible	Identifier Type DeBasis ValueSet	📦1.5.4	de.basisprofil.r4 v1.5
Consent.patient.identifier.​assigner.type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Consent.policyRule	Base	required	v3 Code System ActCode	📦3.0.0	THO v7.1
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.1
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()
kvid-1	warning	Consent.patient.identifier.value	Der unveränderliche Teil der KVID muss 10-stellig sein und mit einem Großbuchstaben anfangen	matches('^[A-Z][0-9]{9}$')
kvid-2	warning	Consent.patient.identifier.type	Die type Codes 'GKV' und 'PKV' haben den Status 'retired', daher sollen diese nicht mehr verwendet werden	($this.coding.exists(system='http://fhir.de/CodeSystem/identifier-type-de-basis' and code='GKV') or $this.coding.exists(system='http://fhir.de/CodeSystem/identifier-type-de-basis' and code='PKV')).not()
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'))

Summary

Mandatory: 3 elements
Must-Support: 8 elements
Fixed: 4 elements

Structures

This structure refers to these other structures:

• Identifier-Profil für die 10-stellige Krankenversichertennummer (http://fhir.de/StructureDefinition/identifier-kvid-10)
• Identifier-Profil für die Abbildung eines Institutionskennzeichens (IKNR) (http://fhir.de/StructureDefinition/identifier-iknr)