CH Consent IG (R5), published by HL7 Switzerland. This guide is not an authorized publication; it is the continuous build for version 1.2.3 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7ch/ch-consent-r5/ and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON

Resource Profile: CH Core Consent

Base definition of the Consent resource for use in Swiss specific use cases.

Usages:

• Examples for this Profile: Consent/GC-accepted, Consent/GC-denied and Consent/PatPortalParticipation-accepted

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Consent		0..*	Consent	A healthcare consumer's or third party's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
contained		0..*	Resource	Contained, inline Resources
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	draft | active | inactive | not-done | entered-in-error | unknown Binding: ConsentState (required): Indicates the state of the consent.
category	Σ	1..*	CodeableConcept	Initial classification of consent, used with provision.code to identify consent types Binding: ConsentCategoriesVS (required)
subject	Σ	1..1	Reference(Patient)	The patient to whom this consent applies to
grantor	Σ	0..*	Reference(Patient | RelatedPerson)	Who is granting rights according to the policy and rules
grantee	Σ	0..*	Reference(Organization | HealthcareService)	Who is agreeing to the policy and rules
manager		0..*	Reference(HealthcareService)	Consent workflow management
controller		0..*	Reference(Organization)	Consent Enforcer
decision	?!Σ	0..1	code	deny | permit Binding: ConsentProvisionType (required): Sets the base decision for Consent to be either permit or deny, with provisions assumed to be a negation of the previous level.
provision	Σ	1..*	BackboneElement	Exeptions/Constraints to the base decision
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code	Σ	1..*	CodeableConcept	Additional classification of consent, used with category to identify consent types Binding: ConsentProvisionCodesVS (required)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	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.ch/ig/ch-consent-r5/ValueSet/ConsentCategoriesVS From this IG
Consent.decision	required	ConsentProvisionType http://hl7.org/fhir/ValueSet/consent-provision-type|5.0.0 From the FHIR Standard
Consent.provision.code	required	ConsentProvisionCodesVS http://fhir.ch/ig/ch-consent-r5/ValueSet/ConsentProvisionCodesVS From this IG

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 Consent

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Consent		0..*	Consent	A healthcare consumer's or third party's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
category		1..*	CodeableConcept	Initial classification of consent, used with provision.code to identify consent types Binding: ConsentCategoriesVS (required)
subject		1..1	Reference(Patient)	The patient to whom this consent applies to
grantor		0..*	Reference(Patient | RelatedPerson)	Who is granting rights according to the policy and rules
grantee		0..*	Reference(Organization | HealthcareService)	Who is agreeing to the policy and rules
manager		0..*	Reference(HealthcareService)	Consent workflow management
controller		0..*	Reference(Organization)	Consent Enforcer
provision		1..*	BackboneElement	Exeptions/Constraints to the base decision
code		1..*	CodeableConcept	Additional classification of consent, used with category to identify consent types Binding: ConsentProvisionCodesVS (required)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Consent.category	required	ConsentCategoriesVS http://fhir.ch/ig/ch-consent-r5/ValueSet/ConsentCategoriesVS From this IG
Consent.provision.code	required	ConsentProvisionCodesVS http://fhir.ch/ig/ch-consent-r5/ValueSet/ConsentProvisionCodesVS From this IG

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Consent		0..*	Consent	A healthcare consumer's or third party's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
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	?!Σ	1..1	code	draft | active | inactive | not-done | entered-in-error | unknown Binding: ConsentState (required): Indicates the state of the consent.
category	Σ	1..*	CodeableConcept	Initial classification of consent, used with provision.code to identify consent types Binding: ConsentCategoriesVS (required)
subject	Σ	1..1	Reference(Patient)	The patient to whom this consent applies to
date	Σ	0..1	date	Fully executed date of the consent
period	Σ	0..1	Period	Effective period for this Consent
grantor	Σ	0..*	Reference(Patient | RelatedPerson)	Who is granting rights according to the policy and rules
grantee	Σ	0..*	Reference(Organization | HealthcareService)	Who is agreeing to the policy and rules
manager		0..*	Reference(HealthcareService)	Consent workflow management
controller		0..*	Reference(Organization)	Consent Enforcer
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	?!Σ	0..1	code	deny | permit Binding: ConsentProvisionType (required): Sets the base decision for Consent to be either permit or deny, with provisions assumed to be a negation of the previous level.
provision	Σ	1..*	BackboneElement	Exeptions/Constraints to the base decision
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
period	Σ	0..1	Period	Timeframe for this provision
actor		0..*	BackboneElement	Who|what controlled by this provision (or group, by role)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
role		0..1	CodeableConcept	How the actor is involved Binding: ParticipationRoleType (extensible): How an actor is involved in the consent considerations.
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	Σ	1..*	CodeableConcept	Additional classification of consent, used with category to identify consent types Binding: ConsentProvisionCodesVS (required)
dataPeriod	Σ	0..1	Period	Timeframe for data controlled by this provision
data	Σ	0..*	BackboneElement	Data controlled by this provision
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
meaning	Σ	1..1	code	instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions.
reference	Σ	1..1	Reference(Resource)	The actual data reference
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	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.ch/ig/ch-consent-r5/ValueSet/ConsentCategoriesVS From this IG
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	extensible	ParticipationRoleType http://hl7.org/fhir/ValueSet/participation-role-type From the FHIR Standard
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.ch/ig/ch-consent-r5/ValueSet/ConsentProvisionCodesVS From this IG
Consent.provision.data.meaning	required	ConsentDataMeaning http://hl7.org/fhir/ValueSet/consent-data-meaning|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 Consent

Summary

Mandatory: 4 elements

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Consent		0..*	Consent	A healthcare consumer's or third party's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
contained		0..*	Resource	Contained, inline Resources
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	draft | active | inactive | not-done | entered-in-error | unknown Binding: ConsentState (required): Indicates the state of the consent.
category	Σ	1..*	CodeableConcept	Initial classification of consent, used with provision.code to identify consent types Binding: ConsentCategoriesVS (required)
subject	Σ	1..1	Reference(Patient)	The patient to whom this consent applies to
grantor	Σ	0..*	Reference(Patient | RelatedPerson)	Who is granting rights according to the policy and rules
grantee	Σ	0..*	Reference(Organization | HealthcareService)	Who is agreeing to the policy and rules
manager		0..*	Reference(HealthcareService)	Consent workflow management
controller		0..*	Reference(Organization)	Consent Enforcer
decision	?!Σ	0..1	code	deny | permit Binding: ConsentProvisionType (required): Sets the base decision for Consent to be either permit or deny, with provisions assumed to be a negation of the previous level.
provision	Σ	1..*	BackboneElement	Exeptions/Constraints to the base decision
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code	Σ	1..*	CodeableConcept	Additional classification of consent, used with category to identify consent types Binding: ConsentProvisionCodesVS (required)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	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.ch/ig/ch-consent-r5/ValueSet/ConsentCategoriesVS From this IG
Consent.decision	required	ConsentProvisionType http://hl7.org/fhir/ValueSet/consent-provision-type|5.0.0 From the FHIR Standard
Consent.provision.code	required	ConsentProvisionCodesVS http://fhir.ch/ig/ch-consent-r5/ValueSet/ConsentProvisionCodesVS From this IG

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 Consent

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Consent		0..*	Consent	A healthcare consumer's or third party's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
category		1..*	CodeableConcept	Initial classification of consent, used with provision.code to identify consent types Binding: ConsentCategoriesVS (required)
subject		1..1	Reference(Patient)	The patient to whom this consent applies to
grantor		0..*	Reference(Patient | RelatedPerson)	Who is granting rights according to the policy and rules
grantee		0..*	Reference(Organization | HealthcareService)	Who is agreeing to the policy and rules
manager		0..*	Reference(HealthcareService)	Consent workflow management
controller		0..*	Reference(Organization)	Consent Enforcer
provision		1..*	BackboneElement	Exeptions/Constraints to the base decision
code		1..*	CodeableConcept	Additional classification of consent, used with category to identify consent types Binding: ConsentProvisionCodesVS (required)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Consent.category	required	ConsentCategoriesVS http://fhir.ch/ig/ch-consent-r5/ValueSet/ConsentCategoriesVS From this IG
Consent.provision.code	required	ConsentProvisionCodesVS http://fhir.ch/ig/ch-consent-r5/ValueSet/ConsentProvisionCodesVS From this IG

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Consent		0..*	Consent	A healthcare consumer's or third party's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
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	?!Σ	1..1	code	draft | active | inactive | not-done | entered-in-error | unknown Binding: ConsentState (required): Indicates the state of the consent.
category	Σ	1..*	CodeableConcept	Initial classification of consent, used with provision.code to identify consent types Binding: ConsentCategoriesVS (required)
subject	Σ	1..1	Reference(Patient)	The patient to whom this consent applies to
date	Σ	0..1	date	Fully executed date of the consent
period	Σ	0..1	Period	Effective period for this Consent
grantor	Σ	0..*	Reference(Patient | RelatedPerson)	Who is granting rights according to the policy and rules
grantee	Σ	0..*	Reference(Organization | HealthcareService)	Who is agreeing to the policy and rules
manager		0..*	Reference(HealthcareService)	Consent workflow management
controller		0..*	Reference(Organization)	Consent Enforcer
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	?!Σ	0..1	code	deny | permit Binding: ConsentProvisionType (required): Sets the base decision for Consent to be either permit or deny, with provisions assumed to be a negation of the previous level.
provision	Σ	1..*	BackboneElement	Exeptions/Constraints to the base decision
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
period	Σ	0..1	Period	Timeframe for this provision
actor		0..*	BackboneElement	Who|what controlled by this provision (or group, by role)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
role		0..1	CodeableConcept	How the actor is involved Binding: ParticipationRoleType (extensible): How an actor is involved in the consent considerations.
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	Σ	1..*	CodeableConcept	Additional classification of consent, used with category to identify consent types Binding: ConsentProvisionCodesVS (required)
dataPeriod	Σ	0..1	Period	Timeframe for data controlled by this provision
data	Σ	0..*	BackboneElement	Data controlled by this provision
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
meaning	Σ	1..1	code	instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions.
reference	Σ	1..1	Reference(Resource)	The actual data reference
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	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.ch/ig/ch-consent-r5/ValueSet/ConsentCategoriesVS From this IG
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	extensible	ParticipationRoleType http://hl7.org/fhir/ValueSet/participation-role-type From the FHIR Standard
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.ch/ig/ch-consent-r5/ValueSet/ConsentProvisionCodesVS From this IG
Consent.provision.data.meaning	required	ConsentDataMeaning http://hl7.org/fhir/ValueSet/consent-data-meaning|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 Consent

Summary

Mandatory: 4 elements

Other representations of profile: CSV, Excel, Schematron

Notes:

[base]/Consent?patient=<patient id>&category=<system|code>&provision-code=<system|code>