Comments on the composition

Status:

• active: For mapping the currently valid version.
• inactive: For past/outdated versions.

Category:
FHIR ConsentScope: patient-privacy
General category for the collection and disclosure of sensitive personal health data.

Provision.code:
FHIR ConsentCategoryCodes: IDSCL Information Disclosure
In combination with the category, should represent the transfer of information or the exclusion of a transfer of information.
If the resource has several provisions, the provision.code must be listed individually in each one.

Decision:
Fixed value permit, all exceptions are recorded in the provision.

Provision.actor:
Only specified if specific exceptions are to be made for individual groups of people (GP, referring doctor/institution, next of kin).
If several groups of people are to be excluded, a separate provision must be attached for each of them.

Provision.data:
Is only specified if restrictions are to apply to a specific encounter, e.g. encounter exclusion.
If the transfer of information is to be restricted for several encounters, several provisions must be attached. One for each affected encounter.
The patient encounter number is given.
If no encounter is specified, the decision on the affected group of persons applies to all patient encounters.

View in KISIM

Displayed in Fallinfo.

Examplesy

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Consent		0..*	KisimCoreConsent	A healthcare consumer's or third party's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
contained		0..*	Resource	Contained, inline Resources
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
status	?!SΣ	1..1	code	active | inactive => active for ongoing order, inactive for expired/past orders. Binding: ConsentState (required): Indicates the state of the consent.
category	SΣ	1..*	CodeableConcept	Initial classification of consent, used with provision.code to identify consent types. Binding: ConsentCategoriesVS (required)
subject	SΣ	1..1	Reference(Patient)	The patient to whom this consent applies to.
date	SΣ	1..1	date	Respresents the date when the entry to the system was made.
period	SΣ	1..1	Period	Effective period for this Consent
start	SΣC	1..1	dateTime	Starting time with inclusive boundary
grantor	SΣ	1..1	Reference(Patient)	Person who has given or denied consent. Generally either patient or legal representative.
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	SΣ	1..1	uri	Patient Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Patient
identifier	ΣC	0..1	Identifier	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 .
system	SΣ	0..1	uri	urn:oid Example General: http://www.acme.com/identifiers/patient
value	SΣC	0..1	string	Patient ID Example General: 123456
grantee	SΣ	1..1	Reference(Organization)	Organization that must follow the instructions of the Consent or is granted rights.
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	SΣ	1..1	uri	Organization Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Organization
identifier	ΣC	0..1	Identifier	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 .
system	SΣ	0..1	uri	urn:oid Example General: http://www.acme.com/identifiers/patient
value	SΣC	0..1	string	UID of the Organization. Example General: 123456
display	SΣC	1..1	string	Name of the Organization as defined in the referenced resource.
manager	S	1..1	Reference(HealthcareService)	Application that recorded/changed the consent. For instance a CIS or a Patientportal.
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	SΣ	1..1	uri	Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: HealthcareService
identifier	ΣC	0..1	Identifier	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 .
system	SΣ	0..1	uri	urn:oid Example General: http://www.acme.com/identifiers/patient
value	SΣC	0..1	string	Name of the Application as defined in the referenced resource. Example General: 123456
display	SΣC	1..1	string	Name of the Application as defined in the referenced resource.
controller	S	1..1	Reference(Organization)	Organization to which the Consent applies.
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	SΣ	1..1	uri	Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Organization
identifier	ΣC	0..1	Identifier	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 .
system	SΣ	0..1	uri	urn:oid Example General: http://www.acme.com/identifiers/patient
value	SΣC	0..1	string	UID of the Organization. Example General: 123456
display	SΣC	1..1	string	Name of the Organization as defined in the referenced resource.
decision	?!SΣ	1..1	code	Only permit, all exceptions are recorded in the provision. Binding: ConsentProvisionType (required): Sets the base decision for Consent to be either permit or deny, with provisions assumed to be a negation of the previous level.
provision	SΣ	1..*	BackboneElement	A separate provision must be created for each actor for which an exception is to be made. The same applies if more than one case is to be restricted.
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
actor		0..*	BackboneElement	Who|what controlled by this provision (or group, by role)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
role	S	0..1	CodeableConcept	GP, referring doctor/institution or next of kin who should not receive any information. Binding: ActorRolesVS (required)
code	SΣ	1..*	CodeableConcept	Additional classification of consent. If there are several provisions, the provision.code must be entered for each of these provisions. Binding: ConsentProvisionCodesVS (required)
data	SΣ	0..*	BackboneElement	If the restriction should only apply to a specific case. If no specific case is specified, the decision applies to all cases.
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
meaning	SΣ	1..1	code	instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. Required Pattern: related
reference	SΣ	1..1	Reference(Encounter)	Encounter/Patientenfall to which the restriction should apply.
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
identifier	ΣC	0..1	Identifier	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 .
value	SΣC	0..1	string	Encounter number of the corresponding case. Example General: 123456
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Consent.status	required	ConsentState http://hl7.org/fhir/ValueSet/consent-state-codes|5.0.0 From the FHIR Standard
Consent.category	required	ConsentCategoriesVS http://fhir.kisimdocs.ch/ig/KisimConsent/ValueSet/ConsentCategoriesVS From this IG
Consent.grantor.type	extensible	Pattern Value: Patient http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Consent.grantor.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 From the FHIR Standard
Consent.grantee.type	extensible	Pattern Value: Organization http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Consent.grantee.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 From the FHIR Standard
Consent.manager.type	extensible	Pattern Value: HealthcareService http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Consent.manager.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 From the FHIR Standard
Consent.controller.type	extensible	Pattern Value: Organization http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Consent.controller.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 From the FHIR Standard
Consent.decision	required	ConsentProvisionType http://hl7.org/fhir/ValueSet/consent-provision-type|5.0.0 From the FHIR Standard
Consent.provision.actor.role	required	ActorRolesVS http://fhir.kisimdocs.ch/ig/KisimConsent/ValueSet/ActorRolesVS From this IG
Consent.provision.code	required	ConsentProvisionCodesVS http://fhir.kisimdocs.ch/ig/KisimConsent/ValueSet/ConsentProvisionCodesVS From this IG
Consent.provision.data.meaning	required	Pattern Value: related http://hl7.org/fhir/ValueSet/consent-data-meaning|5.0.0 From the FHIR Standard
Consent.provision.data.reference.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-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()

This structure is derived from KisimCoreConsent

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Consent		0..*	KisimCoreConsent	A healthcare consumer's or third party's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
status		1..1	code	active | inactive => active for ongoing order, inactive for expired/past orders.
category
coding
system		0..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/consentscope
code		0..1	code	Symbol in syntax defined by the system Required Pattern: patient-privacy
grantor		1..1	Reference(Patient)	Person who has given or denied consent. Generally either patient or legal representative.
type		1..1	uri	Patient Required Pattern: Patient
identifier
value		0..1	string	Patient ID
grantee		1..1	Reference(Organization)	Organization that must follow the instructions of the Consent or is granted rights.
type		1..1	uri	Organization Required Pattern: Organization
identifier
value		0..1	string	UID of the Organization.
display		1..1	string	Name of the Organization as defined in the referenced resource.
decision		1..1	code	Only permit, all exceptions are recorded in the provision.
provision		1..*	BackboneElement	A separate provision must be created for each actor for which an exception is to be made. The same applies if more than one case is to be restricted.
actor
role	S	0..1	CodeableConcept	GP, referring doctor/institution or next of kin who should not receive any information. Binding: ActorRolesVS (required)
code		1..*	CodeableConcept	Additional classification of consent. If there are several provisions, the provision.code must be entered for each of these provisions.
coding
system		0..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v3-ActCode
code		0..1	code	Symbol in syntax defined by the system Required Pattern: IDSCL
data	S	0..*	BackboneElement	If the restriction should only apply to a specific case. If no specific case is specified, the decision applies to all cases.
meaning	S	1..1	code	instance | related | dependents | authoredby Required Pattern: related
reference	S	1..1	Reference(Encounter)	Encounter/Patientenfall to which the restriction should apply.
identifier
value	S	0..1	string	Encounter number of the corresponding case.
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Consent.provision.actor.role	required	ActorRolesVS http://fhir.kisimdocs.ch/ig/KisimConsent/ValueSet/ActorRolesVS From this IG

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Consent		0..*	KisimCoreConsent	A healthcare consumer's or third party's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Identifier for this record (external references)
status	?!SΣ	1..1	code	active | inactive => active for ongoing order, inactive for expired/past orders. Binding: ConsentState (required): Indicates the state of the consent.
category	SΣ	1..*	CodeableConcept	Initial classification of consent, used with provision.code to identify consent types. Binding: ConsentCategoriesVS (required)
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/consentscope
version	Σ	0..1	string	Version of the system - if relevant
code	ΣC	0..1	code	Symbol in syntax defined by the system Required Pattern: patient-privacy
display	ΣC	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
subject	SΣ	1..1	Reference(Patient)	The patient to whom this consent applies to.
date	SΣ	1..1	date	Respresents the date when the entry to the system was made.
period	SΣ	1..1	Period	Effective period for this Consent
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
start	SΣC	1..1	dateTime	Starting time with inclusive boundary
end	ΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing
grantor	SΣ	1..1	Reference(Patient)	Person who has given or denied consent. Generally either patient or legal representative.
id		0..1	id	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	SΣ	1..1	uri	Patient Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Patient
identifier	ΣC	0..1	Identifier	Logical reference, when literal reference is not known
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	0..1	uri	urn:oid Example General: http://www.acme.com/identifiers/patient
value	SΣC	0..1	string	Patient ID Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
display	ΣC	0..1	string	Text alternative for the resource
grantee	SΣ	1..1	Reference(Organization)	Organization that must follow the instructions of the Consent or is granted rights.
id		0..1	id	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	SΣ	1..1	uri	Organization Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Organization
identifier	ΣC	0..1	Identifier	Logical reference, when literal reference is not known
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	0..1	uri	urn:oid Example General: http://www.acme.com/identifiers/patient
value	SΣC	0..1	string	UID of the Organization. Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
display	SΣC	1..1	string	Name of the Organization as defined in the referenced resource.
manager	S	1..1	Reference(HealthcareService)	Application that recorded/changed the consent. For instance a CIS or a Patientportal.
id		0..1	id	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	SΣ	1..1	uri	Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: HealthcareService
identifier	ΣC	0..1	Identifier	Logical reference, when literal reference is not known
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	0..1	uri	urn:oid Example General: http://www.acme.com/identifiers/patient
value	SΣC	0..1	string	Name of the Application as defined in the referenced resource. Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
display	SΣC	1..1	string	Name of the Application as defined in the referenced resource.
controller	S	1..1	Reference(Organization)	Organization to which the Consent applies.
id		0..1	id	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	SΣ	1..1	uri	Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Organization
identifier	ΣC	0..1	Identifier	Logical reference, when literal reference is not known
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	0..1	uri	urn:oid Example General: http://www.acme.com/identifiers/patient
value	SΣC	0..1	string	UID of the Organization. Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
display	SΣC	1..1	string	Name of the Organization as defined in the referenced resource.
sourceAttachment		0..*	Attachment	Source from which this consent is taken
sourceReference		0..*	Reference(Consent | DocumentReference | Contract | QuestionnaireResponse)	Source from which this consent is taken
regulatoryBasis		0..*	CodeableConcept	Regulations establishing base Consent Binding: ConsentPolicyRuleCodes (example): Regulatory policy examples
policyBasis		0..1	BackboneElement	Computable version of the backing policy
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
reference		0..1	Reference(Resource)	Reference backing policy resource
url		0..1	url	URL to a computable backing policy
policyText		0..*	Reference(DocumentReference)	Human Readable Policy
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
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
verified	Σ	1..1	boolean	Has been verified
verificationType		0..1	CodeableConcept	Business case of verification Binding: ConsentVerificationCodes (example): Types of Verification/Validation.
verifiedBy		0..1	Reference(Organization | Practitioner | PractitionerRole)	Person conducting verification
verifiedWith		0..1	Reference(Patient | RelatedPerson)	Person who verified
verificationDate		0..*	dateTime	When consent verified
decision	?!SΣ	1..1	code	Only permit, all exceptions are recorded in the provision. Binding: ConsentProvisionType (required): Sets the base decision for Consent to be either permit or deny, with provisions assumed to be a negation of the previous level.
provision	SΣ	1..*	BackboneElement	A separate provision must be created for each actor for which an exception is to be made. The same applies if more than one case is to be restricted.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
period	Σ	0..1	Period	Timeframe for this provision
actor		0..*	BackboneElement	Who|what controlled by this provision (or group, by role)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
role	S	0..1	CodeableConcept	GP, referring doctor/institution or next of kin who should not receive any information. Binding: ActorRolesVS (required)
reference		0..1	Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole)	Resource for the actor (or group, by role)
action	Σ	0..*	CodeableConcept	Actions controlled by this provision Binding: ConsentActionCodes (example): Detailed codes for the consent action.
securityLabel	Σ	0..*	Coding	Security Labels that define affected resources Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System.
purpose	Σ	0..*	Coding	Context of activities covered by this provision Binding: PurposeOfUse (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels.
documentType	Σ	0..*	Coding	e.g. Resource Type, Profile, CDA, etc Binding: ConsentContentClass (preferred): The document type a consent provision covers.
resourceType	Σ	0..*	Coding	e.g. Resource Type, Profile, etc Binding: ResourceType (extensible): The resource types a consent provision covers.
code	SΣ	1..*	CodeableConcept	Additional classification of consent. If there are several provisions, the provision.code must be entered for each of these provisions. Binding: ConsentProvisionCodesVS (required)
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v3-ActCode
version	Σ	0..1	string	Version of the system - if relevant
code	ΣC	0..1	code	Symbol in syntax defined by the system Required Pattern: IDSCL
display	ΣC	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
dataPeriod	Σ	0..1	Period	Timeframe for data controlled by this provision
data	SΣ	0..*	BackboneElement	If the restriction should only apply to a specific case. If no specific case is specified, the decision applies to all cases.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
meaning	SΣ	1..1	code	instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. Required Pattern: related
reference	SΣ	1..1	Reference(Encounter)	Encounter/Patientenfall to which the restriction should apply.
id		0..1	id	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") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	ΣC	0..1	Identifier	Logical reference, when literal reference is not known
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣC	0..1	string	Encounter number of the corresponding case. Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
display	ΣC	0..1	string	Text alternative for the resource
expression		0..1	Expression	A computable expression of the consent
provision		0..*	See provision (Consent)	Nested Exception Provisions
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Consent.language	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages|5.0.0 From the FHIR Standard
Consent.status	required	ConsentState http://hl7.org/fhir/ValueSet/consent-state-codes|5.0.0 From the FHIR Standard
Consent.category	required	ConsentCategoriesVS http://fhir.kisimdocs.ch/ig/KisimConsent/ValueSet/ConsentCategoriesVS From this IG
Consent.grantor.type	extensible	Pattern Value: Patient http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Consent.grantor.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 From the FHIR Standard
Consent.grantor.identifier.type	extensible	IdentifierTypeCodes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Consent.grantee.type	extensible	Pattern Value: Organization http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Consent.grantee.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 From the FHIR Standard
Consent.grantee.identifier.type	extensible	IdentifierTypeCodes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Consent.manager.type	extensible	Pattern Value: HealthcareService http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Consent.manager.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 From the FHIR Standard
Consent.manager.identifier.type	extensible	IdentifierTypeCodes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Consent.controller.type	extensible	Pattern Value: Organization http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Consent.controller.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 From the FHIR Standard
Consent.controller.identifier.type	extensible	IdentifierTypeCodes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Consent.regulatoryBasis	example	ConsentPolicyRuleCodes http://hl7.org/fhir/ValueSet/consent-policy From the FHIR Standard
Consent.verification.verificationType	example	ConsentVerificationCodes http://hl7.org/fhir/ValueSet/consent-verification From the FHIR Standard
Consent.decision	required	ConsentProvisionType http://hl7.org/fhir/ValueSet/consent-provision-type|5.0.0 From the FHIR Standard
Consent.provision.actor.role	required	ActorRolesVS http://fhir.kisimdocs.ch/ig/KisimConsent/ValueSet/ActorRolesVS From this IG
Consent.provision.action	example	ConsentActionCodes http://hl7.org/fhir/ValueSet/consent-action From the FHIR Standard
Consent.provision.securityLabel	example	SecurityLabelExamples http://hl7.org/fhir/ValueSet/security-label-examples From the FHIR Standard
Consent.provision.purpose	extensible	PurposeOfUse http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
Consent.provision.documentType	preferred	ConsentContentClass http://hl7.org/fhir/ValueSet/consent-content-class From the FHIR Standard
Consent.provision.resourceType	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Consent.provision.code	required	ConsentProvisionCodesVS http://fhir.kisimdocs.ch/ig/KisimConsent/ValueSet/ConsentProvisionCodesVS From this IG
Consent.provision.data.meaning	required	Pattern Value: related http://hl7.org/fhir/ValueSet/consent-data-meaning|5.0.0 From the FHIR Standard
Consent.provision.data.reference.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Consent.provision.data.reference.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 From the FHIR Standard
Consent.provision.data.reference.identifier.type	extensible	IdentifierTypeCodes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-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()

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Consent		0..*	KisimCoreConsent	A healthcare consumer's or third party's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
contained		0..*	Resource	Contained, inline Resources
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
status	?!SΣ	1..1	code	active | inactive => active for ongoing order, inactive for expired/past orders. Binding: ConsentState (required): Indicates the state of the consent.
category	SΣ	1..*	CodeableConcept	Initial classification of consent, used with provision.code to identify consent types. Binding: ConsentCategoriesVS (required)
subject	SΣ	1..1	Reference(Patient)	The patient to whom this consent applies to.
date	SΣ	1..1	date	Respresents the date when the entry to the system was made.
period	SΣ	1..1	Period	Effective period for this Consent
start	SΣC	1..1	dateTime	Starting time with inclusive boundary
grantor	SΣ	1..1	Reference(Patient)	Person who has given or denied consent. Generally either patient or legal representative.
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	SΣ	1..1	uri	Patient Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Patient
identifier	ΣC	0..1	Identifier	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 .
system	SΣ	0..1	uri	urn:oid Example General: http://www.acme.com/identifiers/patient
value	SΣC	0..1	string	Patient ID Example General: 123456
grantee	SΣ	1..1	Reference(Organization)	Organization that must follow the instructions of the Consent or is granted rights.
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	SΣ	1..1	uri	Organization Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Organization
identifier	ΣC	0..1	Identifier	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 .
system	SΣ	0..1	uri	urn:oid Example General: http://www.acme.com/identifiers/patient
value	SΣC	0..1	string	UID of the Organization. Example General: 123456
display	SΣC	1..1	string	Name of the Organization as defined in the referenced resource.
manager	S	1..1	Reference(HealthcareService)	Application that recorded/changed the consent. For instance a CIS or a Patientportal.
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	SΣ	1..1	uri	Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: HealthcareService
identifier	ΣC	0..1	Identifier	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 .
system	SΣ	0..1	uri	urn:oid Example General: http://www.acme.com/identifiers/patient
value	SΣC	0..1	string	Name of the Application as defined in the referenced resource. Example General: 123456
display	SΣC	1..1	string	Name of the Application as defined in the referenced resource.
controller	S	1..1	Reference(Organization)	Organization to which the Consent applies.
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	SΣ	1..1	uri	Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Organization
identifier	ΣC	0..1	Identifier	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 .
system	SΣ	0..1	uri	urn:oid Example General: http://www.acme.com/identifiers/patient
value	SΣC	0..1	string	UID of the Organization. Example General: 123456
display	SΣC	1..1	string	Name of the Organization as defined in the referenced resource.
decision	?!SΣ	1..1	code	Only permit, all exceptions are recorded in the provision. Binding: ConsentProvisionType (required): Sets the base decision for Consent to be either permit or deny, with provisions assumed to be a negation of the previous level.
provision	SΣ	1..*	BackboneElement	A separate provision must be created for each actor for which an exception is to be made. The same applies if more than one case is to be restricted.
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
actor		0..*	BackboneElement	Who|what controlled by this provision (or group, by role)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
role	S	0..1	CodeableConcept	GP, referring doctor/institution or next of kin who should not receive any information. Binding: ActorRolesVS (required)
code	SΣ	1..*	CodeableConcept	Additional classification of consent. If there are several provisions, the provision.code must be entered for each of these provisions. Binding: ConsentProvisionCodesVS (required)
data	SΣ	0..*	BackboneElement	If the restriction should only apply to a specific case. If no specific case is specified, the decision applies to all cases.
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
meaning	SΣ	1..1	code	instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. Required Pattern: related
reference	SΣ	1..1	Reference(Encounter)	Encounter/Patientenfall to which the restriction should apply.
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
identifier	ΣC	0..1	Identifier	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 .
value	SΣC	0..1	string	Encounter number of the corresponding case. Example General: 123456
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Consent.status	required	ConsentState http://hl7.org/fhir/ValueSet/consent-state-codes|5.0.0 From the FHIR Standard
Consent.category	required	ConsentCategoriesVS http://fhir.kisimdocs.ch/ig/KisimConsent/ValueSet/ConsentCategoriesVS From this IG
Consent.grantor.type	extensible	Pattern Value: Patient http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Consent.grantor.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 From the FHIR Standard
Consent.grantee.type	extensible	Pattern Value: Organization http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Consent.grantee.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 From the FHIR Standard
Consent.manager.type	extensible	Pattern Value: HealthcareService http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Consent.manager.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 From the FHIR Standard
Consent.controller.type	extensible	Pattern Value: Organization http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Consent.controller.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 From the FHIR Standard
Consent.decision	required	ConsentProvisionType http://hl7.org/fhir/ValueSet/consent-provision-type|5.0.0 From the FHIR Standard
Consent.provision.actor.role	required	ActorRolesVS http://fhir.kisimdocs.ch/ig/KisimConsent/ValueSet/ActorRolesVS From this IG
Consent.provision.code	required	ConsentProvisionCodesVS http://fhir.kisimdocs.ch/ig/KisimConsent/ValueSet/ConsentProvisionCodesVS From this IG
Consent.provision.data.meaning	required	Pattern Value: related http://hl7.org/fhir/ValueSet/consent-data-meaning|5.0.0 From the FHIR Standard
Consent.provision.data.reference.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-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()

Differential View

This structure is derived from KisimCoreConsent

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Consent		0..*	KisimCoreConsent	A healthcare consumer's or third party's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
status		1..1	code	active | inactive => active for ongoing order, inactive for expired/past orders.
category
coding
system		0..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/consentscope
code		0..1	code	Symbol in syntax defined by the system Required Pattern: patient-privacy
grantor		1..1	Reference(Patient)	Person who has given or denied consent. Generally either patient or legal representative.
type		1..1	uri	Patient Required Pattern: Patient
identifier
value		0..1	string	Patient ID
grantee		1..1	Reference(Organization)	Organization that must follow the instructions of the Consent or is granted rights.
type		1..1	uri	Organization Required Pattern: Organization
identifier
value		0..1	string	UID of the Organization.
display		1..1	string	Name of the Organization as defined in the referenced resource.
decision		1..1	code	Only permit, all exceptions are recorded in the provision.
provision		1..*	BackboneElement	A separate provision must be created for each actor for which an exception is to be made. The same applies if more than one case is to be restricted.
actor
role	S	0..1	CodeableConcept	GP, referring doctor/institution or next of kin who should not receive any information. Binding: ActorRolesVS (required)
code		1..*	CodeableConcept	Additional classification of consent. If there are several provisions, the provision.code must be entered for each of these provisions.
coding
system		0..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v3-ActCode
code		0..1	code	Symbol in syntax defined by the system Required Pattern: IDSCL
data	S	0..*	BackboneElement	If the restriction should only apply to a specific case. If no specific case is specified, the decision applies to all cases.
meaning	S	1..1	code	instance | related | dependents | authoredby Required Pattern: related
reference	S	1..1	Reference(Encounter)	Encounter/Patientenfall to which the restriction should apply.
identifier
value	S	0..1	string	Encounter number of the corresponding case.
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Consent.provision.actor.role	required	ActorRolesVS http://fhir.kisimdocs.ch/ig/KisimConsent/ValueSet/ActorRolesVS From this IG

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Consent		0..*	KisimCoreConsent	A healthcare consumer's or third party's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Identifier for this record (external references)
status	?!SΣ	1..1	code	active | inactive => active for ongoing order, inactive for expired/past orders. Binding: ConsentState (required): Indicates the state of the consent.
category	SΣ	1..*	CodeableConcept	Initial classification of consent, used with provision.code to identify consent types. Binding: ConsentCategoriesVS (required)
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/consentscope
version	Σ	0..1	string	Version of the system - if relevant
code	ΣC	0..1	code	Symbol in syntax defined by the system Required Pattern: patient-privacy
display	ΣC	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
subject	SΣ	1..1	Reference(Patient)	The patient to whom this consent applies to.
date	SΣ	1..1	date	Respresents the date when the entry to the system was made.
period	SΣ	1..1	Period	Effective period for this Consent
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
start	SΣC	1..1	dateTime	Starting time with inclusive boundary
end	ΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing
grantor	SΣ	1..1	Reference(Patient)	Person who has given or denied consent. Generally either patient or legal representative.
id		0..1	id	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	SΣ	1..1	uri	Patient Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Patient
identifier	ΣC	0..1	Identifier	Logical reference, when literal reference is not known
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	0..1	uri	urn:oid Example General: http://www.acme.com/identifiers/patient
value	SΣC	0..1	string	Patient ID Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
display	ΣC	0..1	string	Text alternative for the resource
grantee	SΣ	1..1	Reference(Organization)	Organization that must follow the instructions of the Consent or is granted rights.
id		0..1	id	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	SΣ	1..1	uri	Organization Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Organization
identifier	ΣC	0..1	Identifier	Logical reference, when literal reference is not known
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	0..1	uri	urn:oid Example General: http://www.acme.com/identifiers/patient
value	SΣC	0..1	string	UID of the Organization. Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
display	SΣC	1..1	string	Name of the Organization as defined in the referenced resource.
manager	S	1..1	Reference(HealthcareService)	Application that recorded/changed the consent. For instance a CIS or a Patientportal.
id		0..1	id	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	SΣ	1..1	uri	Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: HealthcareService
identifier	ΣC	0..1	Identifier	Logical reference, when literal reference is not known
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	0..1	uri	urn:oid Example General: http://www.acme.com/identifiers/patient
value	SΣC	0..1	string	Name of the Application as defined in the referenced resource. Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
display	SΣC	1..1	string	Name of the Application as defined in the referenced resource.
controller	S	1..1	Reference(Organization)	Organization to which the Consent applies.
id		0..1	id	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	SΣ	1..1	uri	Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Organization
identifier	ΣC	0..1	Identifier	Logical reference, when literal reference is not known
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	0..1	uri	urn:oid Example General: http://www.acme.com/identifiers/patient
value	SΣC	0..1	string	UID of the Organization. Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
display	SΣC	1..1	string	Name of the Organization as defined in the referenced resource.
sourceAttachment		0..*	Attachment	Source from which this consent is taken
sourceReference		0..*	Reference(Consent | DocumentReference | Contract | QuestionnaireResponse)	Source from which this consent is taken
regulatoryBasis		0..*	CodeableConcept	Regulations establishing base Consent Binding: ConsentPolicyRuleCodes (example): Regulatory policy examples
policyBasis		0..1	BackboneElement	Computable version of the backing policy
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
reference		0..1	Reference(Resource)	Reference backing policy resource
url		0..1	url	URL to a computable backing policy
policyText		0..*	Reference(DocumentReference)	Human Readable Policy
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
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
verified	Σ	1..1	boolean	Has been verified
verificationType		0..1	CodeableConcept	Business case of verification Binding: ConsentVerificationCodes (example): Types of Verification/Validation.
verifiedBy		0..1	Reference(Organization | Practitioner | PractitionerRole)	Person conducting verification
verifiedWith		0..1	Reference(Patient | RelatedPerson)	Person who verified
verificationDate		0..*	dateTime	When consent verified
decision	?!SΣ	1..1	code	Only permit, all exceptions are recorded in the provision. Binding: ConsentProvisionType (required): Sets the base decision for Consent to be either permit or deny, with provisions assumed to be a negation of the previous level.
provision	SΣ	1..*	BackboneElement	A separate provision must be created for each actor for which an exception is to be made. The same applies if more than one case is to be restricted.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
period	Σ	0..1	Period	Timeframe for this provision
actor		0..*	BackboneElement	Who|what controlled by this provision (or group, by role)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
role	S	0..1	CodeableConcept	GP, referring doctor/institution or next of kin who should not receive any information. Binding: ActorRolesVS (required)
reference		0..1	Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole)	Resource for the actor (or group, by role)
action	Σ	0..*	CodeableConcept	Actions controlled by this provision Binding: ConsentActionCodes (example): Detailed codes for the consent action.
securityLabel	Σ	0..*	Coding	Security Labels that define affected resources Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System.
purpose	Σ	0..*	Coding	Context of activities covered by this provision Binding: PurposeOfUse (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels.
documentType	Σ	0..*	Coding	e.g. Resource Type, Profile, CDA, etc Binding: ConsentContentClass (preferred): The document type a consent provision covers.
resourceType	Σ	0..*	Coding	e.g. Resource Type, Profile, etc Binding: ResourceType (extensible): The resource types a consent provision covers.
code	SΣ	1..*	CodeableConcept	Additional classification of consent. If there are several provisions, the provision.code must be entered for each of these provisions. Binding: ConsentProvisionCodesVS (required)
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v3-ActCode
version	Σ	0..1	string	Version of the system - if relevant
code	ΣC	0..1	code	Symbol in syntax defined by the system Required Pattern: IDSCL
display	ΣC	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
dataPeriod	Σ	0..1	Period	Timeframe for data controlled by this provision
data	SΣ	0..*	BackboneElement	If the restriction should only apply to a specific case. If no specific case is specified, the decision applies to all cases.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
meaning	SΣ	1..1	code	instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. Required Pattern: related
reference	SΣ	1..1	Reference(Encounter)	Encounter/Patientenfall to which the restriction should apply.
id		0..1	id	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") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	ΣC	0..1	Identifier	Logical reference, when literal reference is not known
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣC	0..1	string	Encounter number of the corresponding case. Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
display	ΣC	0..1	string	Text alternative for the resource
expression		0..1	Expression	A computable expression of the consent
provision		0..*	See provision (Consent)	Nested Exception Provisions
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Consent.language	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages|5.0.0 From the FHIR Standard
Consent.status	required	ConsentState http://hl7.org/fhir/ValueSet/consent-state-codes|5.0.0 From the FHIR Standard
Consent.category	required	ConsentCategoriesVS http://fhir.kisimdocs.ch/ig/KisimConsent/ValueSet/ConsentCategoriesVS From this IG
Consent.grantor.type	extensible	Pattern Value: Patient http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Consent.grantor.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 From the FHIR Standard
Consent.grantor.identifier.type	extensible	IdentifierTypeCodes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Consent.grantee.type	extensible	Pattern Value: Organization http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Consent.grantee.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 From the FHIR Standard
Consent.grantee.identifier.type	extensible	IdentifierTypeCodes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Consent.manager.type	extensible	Pattern Value: HealthcareService http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Consent.manager.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 From the FHIR Standard
Consent.manager.identifier.type	extensible	IdentifierTypeCodes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Consent.controller.type	extensible	Pattern Value: Organization http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Consent.controller.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 From the FHIR Standard
Consent.controller.identifier.type	extensible	IdentifierTypeCodes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Consent.regulatoryBasis	example	ConsentPolicyRuleCodes http://hl7.org/fhir/ValueSet/consent-policy From the FHIR Standard
Consent.verification.verificationType	example	ConsentVerificationCodes http://hl7.org/fhir/ValueSet/consent-verification From the FHIR Standard
Consent.decision	required	ConsentProvisionType http://hl7.org/fhir/ValueSet/consent-provision-type|5.0.0 From the FHIR Standard
Consent.provision.actor.role	required	ActorRolesVS http://fhir.kisimdocs.ch/ig/KisimConsent/ValueSet/ActorRolesVS From this IG
Consent.provision.action	example	ConsentActionCodes http://hl7.org/fhir/ValueSet/consent-action From the FHIR Standard
Consent.provision.securityLabel	example	SecurityLabelExamples http://hl7.org/fhir/ValueSet/security-label-examples From the FHIR Standard
Consent.provision.purpose	extensible	PurposeOfUse http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
Consent.provision.documentType	preferred	ConsentContentClass http://hl7.org/fhir/ValueSet/consent-content-class From the FHIR Standard
Consent.provision.resourceType	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Consent.provision.code	required	ConsentProvisionCodesVS http://fhir.kisimdocs.ch/ig/KisimConsent/ValueSet/ConsentProvisionCodesVS From this IG
Consent.provision.data.meaning	required	Pattern Value: related http://hl7.org/fhir/ValueSet/consent-data-meaning|5.0.0 From the FHIR Standard
Consent.provision.data.reference.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Consent.provision.data.reference.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 From the FHIR Standard
Consent.provision.data.reference.identifier.type	extensible	IdentifierTypeCodes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-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()

This structure is derived from KisimCoreConsent

Summary

Mandatory: 1 element
Must-Support: 5 elements