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

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

Resource Profile: CH Core Consent

Usages:

• Derived from this Profile: CH Core General Consent
• Examples for this Profile: Consent/PatPortalParticipation-accepted

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Consent	C	0..*	Profile_R5_Consent_R4	A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time Constraints: ppc-1, ppc-2, ppc-3, ppc-4, ppc-5
Consent.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Consent.Slices for extension				Content/Rules for all slices
Consent.Slices for extension.extension:period		0..1	Period	R5: Effective period for this Consent (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.period Constraints: ext-1
Consent.Slices for extension.extension:grantor		0..*	(Complex)	R5: Who is granting rights according to the policy and rules (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor Constraints: ext-1
Consent.Slices for extension.extension:grantor.extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Consent.Slices for extension.extension:grantor.url		1..1	uri	"http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor"
Consent.Slices for extension.extension:grantor.value[x]		0..1	Reference(Patient | RelatedPerson | Organization)	Who is granting rights according to the policy and rules
Consent.Slices for extension.extension:manager		0..*	(Complex)	R5: Consent workflow management (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.manager Constraints: ext-1
Consent.Slices for extension.extension:manager.extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Consent.Slices for extension.extension:manager.url		1..1	uri	"http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.manager"
Consent.Slices for extension.extension:manager.value[x]		0..1	Reference(HealthcareService)	Consent workflow management
Consent.Slices for extension.extension:controller		0..*	(Complex)	R5: Consent Enforcer (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.controller Constraints: ext-1
Consent.Slices for extension.extension:controller.extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Consent.Slices for extension.extension:controller.url		1..1	uri	"http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.controller"
Consent.Slices for extension.extension:controller.value[x]		0..1	Reference(Organization)	Consent Enforcer
Consent.Slices for extension.extension:policyText		0..*	Reference(Cross-version Profile for R5.DocumentReference for use in FHIR R4(0.1.0) | Media)	R5: Human Readable Policy (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.policyText Constraints: ext-1
Consent.Slices for modifierExtension	?! This element is a modifier element.	0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
Consent.Slices for modifierExtension.modifierExtension:decision	?! This element is a modifier element.	0..1	code	R5: deny | permit (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.decision 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. Constraints: ext-1
Consent.status	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent.
Consent.status.Slices for extension				Content/Rules for all slices
Consent.status.Slices for extension.extension:status		0..1	code	R5: draft | active | inactive | not-done | entered-in-error | unknown URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.status Binding: R5ConsentStateCodesForR4 (0.1.0) (required): Indicates the state of the consent. Constraints: ext-1
Consent.scope	?! This element is a modifier element. Σ This element is included in summaries.	1..1	CodeableConcept	Which of the four areas this resource covers (extensible) Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource.
Consent.category	Σ This element is included in summaries.	1..*	CodeableConcept	Initial classification of consent, used with provision.code to identify consent types Binding: ConsentCategoriesVS (required)
Consent.patient	Σ This element is included in summaries.	1..1	Reference(Patient)	The patient to whom this consent applies to
Consent.patient.Slices for extension				Content/Rules for all slices
Consent.patient.Slices for extension.extension:subject		0..1	Reference(Resource)	R5: subject URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1
Consent.performer	Σ This element is included in summaries.	0..*	Reference(Organization)	Grantee (Organization). For HealthcareService grantees, use the alternate-reference extension on performer.
Consent.performer.Slices for extension				Content/Rules for all slices
Consent.performer.Slices for extension.extension:grantee		0..1	Reference(Resource)	R5: grantee URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1
Consent.provision	Σ This element is included in summaries.	1..1	BackboneElement	Exceptions/Constraints to the base decision
Consent.provision.Slices for extension				Content/Rules for all slices
Consent.provision.Slices for extension.extension:expression		0..1	Expression	R5: A computable expression of the consent (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.provision.expression Constraints: ext-1
Consent.provision.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
Consent.provision.code	Σ This element is included in summaries.	1..*	CodeableConcept	Additional classification of consent, used with category to identify consent types Binding: ConsentProvisionCodesVS (required)
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Consent.status	Base	required	ConsentState	📍4.0.1	FHIR Std.
Consent.scope	Base	extensible	Consent Scope Codes	📍4.0.1	FHIR Std.
Consent.category	Base	required	ConsentCategoriesVS	📦7.0.0-ballot	This IG
Consent.provision.code	Base	required	ConsentProvisionCodesVS	📦7.0.0-ballot	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	Consent	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Consent	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Consent	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Consent	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Consent	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	Consent.implicitRules, Consent.extension:period, Consent.extension:grantor, Consent.extension:grantor.value[x], Consent.extension:manager, Consent.extension:manager.value[x], Consent.extension:controller, Consent.extension:controller.value[x], Consent.extension:policyText, Consent.modifierExtension, Consent.modifierExtension:decision, Consent.status, Consent.status.extension:status, Consent.scope, Consent.category, Consent.patient, Consent.patient.extension:subject, Consent.performer, Consent.performer.extension:grantee, Consent.provision, Consent.provision.extension:expression, Consent.provision.modifierExtension, Consent.provision.code	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	Consent.extension:period, Consent.extension:grantor, Consent.extension:manager, Consent.extension:controller, Consent.extension:policyText, Consent.modifierExtension, Consent.modifierExtension:decision, Consent.status.extension:status, Consent.patient.extension:subject, Consent.performer.extension:grantee, Consent.provision.extension:expression, Consent.provision.modifierExtension	Must have either extensions or value[x], not both	extension.exists() != value.exists()
ppc-1	error	Consent	Either a Policy or PolicyRule	policy.exists() or policyRule.exists()
ppc-2	error	Consent	IF Scope=privacy, there must be a patient	patient.exists() or scope.coding.where(system='something' and code='patient-privacy').exists().not()
ppc-3	error	Consent	IF Scope=research, there must be a patient	patient.exists() or scope.coding.where(system='something' and code='research').exists().not()
ppc-4	error	Consent	IF Scope=adr, there must be a patient	patient.exists() or scope.coding.where(system='something' and code='adr').exists().not()
ppc-5	error	Consent	IF Scope=treatment, there must be a patient	patient.exists() or scope.coding.where(system='something' and code='treatment').exists().not()

This structure is derived from Profile_R5_Consent_R4

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Consent		0..*	Profile_R5_Consent_R4	A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
Consent.Slices for extension				Content/Rules for all slices
Consent.Slices for extension.extension:grantor		0..*	0.1.0	R5: Who is granting rights according to the policy and rules (new)
Consent.Slices for extension.extension:grantor.extension		0..0		Extension
Consent.Slices for extension.extension:grantor.value[x]		0..1	Reference(Patient | RelatedPerson | Organization)	Who is granting rights according to the policy and rules
Consent.Slices for extension.extension:manager		0..*	0.1.0	R5: Consent workflow management (new)
Consent.Slices for extension.extension:manager.extension		0..0		Extension
Consent.Slices for extension.extension:manager.value[x]		0..1	Reference(HealthcareService)	Consent workflow management
Consent.Slices for extension.extension:controller		0..*	0.1.0	R5: Consent Enforcer (new)
Consent.Slices for extension.extension:controller.extension		0..0		Extension
Consent.Slices for extension.extension:controller.value[x]		0..1	Reference(Organization)	Consent Enforcer
Consent.category		1..*	CodeableConcept	Initial classification of consent, used with provision.code to identify consent types Binding: ConsentCategoriesVS (required)
Consent.patient		1..1	Reference(Patient)	The patient to whom this consent applies to
Consent.performer		0..*	Reference(Organization)	Grantee (Organization). For HealthcareService grantees, use the alternate-reference extension on performer.
Consent.provision		1..1	BackboneElement	Exceptions/Constraints to the base decision
Consent.provision.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	Status	Usage	ValueSet	Version	Source
Consent.category	Base	required	ConsentCategoriesVS	📦7.0.0-ballot	This IG
Consent.provision.code	Base	required	ConsentProvisionCodesVS	📦7.0.0-ballot	This IG

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Consent	C	0..*	Profile_R5_Consent_R4	A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time Constraints: ppc-1, ppc-2, ppc-3, ppc-4, ppc-5
Consent.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
Consent.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Consent.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Consent.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Consent.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
Consent.contained		0..*	Resource	Contained, inline Resources
Consent.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
Consent.Slices for extension.extension:period		0..1	Period	R5: Effective period for this Consent (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.period Constraints: ext-1
Consent.Slices for extension.extension:grantor		0..*	(Complex)	R5: Who is granting rights according to the policy and rules (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor Constraints: ext-1
Consent.Slices for extension.extension:grantor.id		0..1	string	Unique id for inter-element referencing
Consent.Slices for extension.extension:grantor.extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Consent.Slices for extension.extension:grantor.url		1..1	uri	"http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor"
Consent.Slices for extension.extension:grantor.value[x]		0..1	Reference(Patient | RelatedPerson | Organization)	Who is granting rights according to the policy and rules
Consent.Slices for extension.extension:manager		0..*	(Complex)	R5: Consent workflow management (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.manager Constraints: ext-1
Consent.Slices for extension.extension:manager.id		0..1	string	Unique id for inter-element referencing
Consent.Slices for extension.extension:manager.extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Consent.Slices for extension.extension:manager.url		1..1	uri	"http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.manager"
Consent.Slices for extension.extension:manager.value[x]		0..1	Reference(HealthcareService)	Consent workflow management
Consent.Slices for extension.extension:controller		0..*	(Complex)	R5: Consent Enforcer (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.controller Constraints: ext-1
Consent.Slices for extension.extension:controller.id		0..1	string	Unique id for inter-element referencing
Consent.Slices for extension.extension:controller.extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Consent.Slices for extension.extension:controller.url		1..1	uri	"http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.controller"
Consent.Slices for extension.extension:controller.value[x]		0..1	Reference(Organization)	Consent Enforcer
Consent.Slices for extension.extension:policyText		0..*	Reference(Cross-version Profile for R5.DocumentReference for use in FHIR R4(0.1.0) | Media)	R5: Human Readable Policy (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.policyText Constraints: ext-1
Consent.Slices for modifierExtension	?! This element is a modifier element.	0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
Consent.Slices for modifierExtension.modifierExtension:decision	?! This element is a modifier element.	0..1	code	R5: deny | permit (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.decision 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. Constraints: ext-1
Consent.identifier	Σ This element is included in summaries.	0..*	Identifier	Identifier for this record (external references) Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"}
Consent.status	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent.
Consent.status.id		0..1	string	xml:id (or equivalent in JSON)
Consent.status.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
Consent.status.Slices for extension.extension:status		0..1	code	R5: draft | active | inactive | not-done | entered-in-error | unknown URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.status Binding: R5ConsentStateCodesForR4 (0.1.0) (required): Indicates the state of the consent. Constraints: ext-1
Consent.status.value		0..1	string	Primitive value for code
Consent.scope	?! This element is a modifier element. Σ This element is included in summaries.	1..1	CodeableConcept	Which of the four areas this resource covers (extensible) Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource.
Consent.category	Σ This element is included in summaries.	1..*	CodeableConcept	Initial classification of consent, used with provision.code to identify consent types Binding: ConsentCategoriesVS (required)
Consent.patient	Σ This element is included in summaries.	1..1	Reference(Patient)	The patient to whom this consent applies to
Consent.patient.id		0..1	string	Unique id for inter-element referencing
Consent.patient.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
Consent.patient.Slices for extension.extension:subject		0..1	Reference(Resource)	R5: subject URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1
Consent.patient.reference	Σ This element is included in summaries. C	0..1	string	Literal reference, Relative, internal or absolute URL
Consent.patient.type	Σ This element is included in summaries.	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Consent.patient.identifier	Σ This element is included in summaries.	0..1	Identifier	Logical reference, when literal reference is not known
Consent.patient.display	Σ This element is included in summaries.	0..1	string	Text alternative for the resource
Consent.dateTime	Σ This element is included in summaries.	0..1	dateTime	When this Consent was created or indexed
Consent.performer	Σ This element is included in summaries.	0..*	Reference(Organization)	Grantee (Organization). For HealthcareService grantees, use the alternate-reference extension on performer.
Consent.performer.id		0..1	string	Unique id for inter-element referencing
Consent.performer.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
Consent.performer.Slices for extension.extension:grantee		0..1	Reference(Resource)	R5: grantee URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1
Consent.performer.reference	Σ This element is included in summaries. C	0..1	string	Literal reference, Relative, internal or absolute URL
Consent.performer.type	Σ This element is included in summaries.	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Consent.performer.identifier	Σ This element is included in summaries.	0..1	Identifier	Logical reference, when literal reference is not known
Consent.performer.display	Σ This element is included in summaries.	0..1	string	Text alternative for the resource
Consent.organization	Σ This element is included in summaries.	0..*	Reference(Organization)	Custodian of the consent
Consent.source[x]	Σ This element is included in summaries.	0..1		Source from which this consent is taken
Consent.source[x].source[x]All Types				Content/Rules for all Types
Consent.source[x].source[x]All Types.id		0..1	string	Unique id for inter-element referencing
Consent.source[x].source[x]All Types.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
Consent.source[x].source[x]All Types.Slices for extension.extension:alternateReference		0..1	Reference(Resource)	R5: sourceReference URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1
Consent.source[x].sourceAttachment			Attachment
Consent.source[x].sourceReference			Reference(Consent | DocumentReference | Contract | QuestionnaireResponse)
Consent.policy		0..*	BackboneElement	Policies covered by this consent
Consent.policy.id		0..1	string	Unique id for inter-element referencing
Consent.policy.extension		0..*	Extension	Additional content defined by implementations Constraints: ext-1
Consent.policy.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
Consent.policy.authority	C	0..1	uri	Enforcement source for policy
Consent.policy.uri	C	0..1	uri	Specific policy covered by this consent
Consent.policyRule	Σ This element is included in summaries. C	0..1	CodeableConcept	Regulation that this consents to Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples.
Consent.verification	Σ This element is included in summaries.	0..*	BackboneElement	Consent Verified by patient or family
Consent.verification.id		0..1	string	Unique id for inter-element referencing
Consent.verification.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
Consent.verification.Slices for extension.extension:verificationType		0..1	CodeableConcept	R5: Business case of verification (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.verification.verificationType Binding: R5ConsentVerificationForR4 (0.1.0) (example): Types of Verification/Validation. Constraints: ext-1
Consent.verification.Slices for extension.extension:verifiedBy		0..1	Reference(Cross-version Profile for R5.Organization for use in FHIR R4(0.1.0) | Organization | Cross-version Profile for R5.Practitioner for use in FHIR R4(0.1.0) | Practitioner | Cross-version Profile for R5.PractitionerRole for use in FHIR R4(0.1.0) | PractitionerRole)	R5: Person conducting verification (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.verification.verifiedBy Constraints: ext-1
Consent.verification.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
Consent.verification.verified	Σ This element is included in summaries.	1..1	boolean	Has been verified
Consent.verification.verifiedWith		0..1	Reference(Patient | RelatedPerson)	Person who verified
Consent.verification.verificationDate		0..1	dateTime	When consent verified
Consent.provision	Σ This element is included in summaries.	1..1	BackboneElement	Exceptions/Constraints to the base decision
Consent.provision.id		0..1	string	Unique id for inter-element referencing
Consent.provision.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
Consent.provision.Slices for extension.extension:expression		0..1	Expression	R5: A computable expression of the consent (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.provision.expression Constraints: ext-1
Consent.provision.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
Consent.provision.type	Σ This element is included in summaries.	0..1	code	deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent.
Consent.provision.period	Σ This element is included in summaries.	0..1	Period	Timeframe for this rule
Consent.provision.actor		0..*	BackboneElement	Who|what controlled by this rule (or group, by role)
Consent.provision.actor.id		0..1	string	Unique id for inter-element referencing
Consent.provision.actor.extension		0..*	Extension	Additional content defined by implementations Constraints: ext-1
Consent.provision.actor.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
Consent.provision.actor.role		1..1	CodeableConcept	How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.
Consent.provision.actor.reference		1..1	Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole)	Resource for the actor (or group, by role)
Consent.provision.action	Σ This element is included in summaries.	0..*	CodeableConcept	Actions controlled by this rule Binding: ConsentActionCodes (example): Detailed codes for the consent action.
Consent.provision.securityLabel	Σ This element is included in summaries.	0..*	Coding	Security Labels that define affected resources Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Consent.provision.purpose	Σ This element is included in summaries.	0..*	Coding	Context of activities covered by this rule Binding: PurposeOfUse (3.1.0) (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels.
Consent.provision.class	Σ This element is included in summaries.	0..*	Coding	e.g. Resource Type, Profile, CDA, etc. Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers.
Consent.provision.code	Σ This element is included in summaries.	1..*	CodeableConcept	Additional classification of consent, used with category to identify consent types Binding: ConsentProvisionCodesVS (required)
Consent.provision.dataPeriod	Σ This element is included in summaries.	0..1	Period	Timeframe for data controlled by this rule
Consent.provision.data	Σ This element is included in summaries.	0..*	BackboneElement	Data controlled by this rule
Consent.provision.data.id		0..1	string	Unique id for inter-element referencing
Consent.provision.data.extension		0..*	Extension	Additional content defined by implementations Constraints: ext-1
Consent.provision.data.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
Consent.provision.data.meaning	Σ This element is included in summaries.	1..1	code	instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions.
Consent.provision.data.reference	Σ This element is included in summaries.	1..1	Reference(Resource)	The actual data reference
Consent.provision.provision		0..*	See provision (Consent)	Nested Exception Rules
Documentation for this format

Terminology Bindings

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

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	Consent	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Consent	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Consent	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Consent	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Consent	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	Consent.meta, Consent.implicitRules, Consent.language, Consent.text, Consent.extension, Consent.extension:period, Consent.extension:grantor, Consent.extension:grantor.value[x], Consent.extension:manager, Consent.extension:manager.value[x], Consent.extension:controller, Consent.extension:controller.value[x], Consent.extension:policyText, Consent.modifierExtension, Consent.modifierExtension:decision, Consent.identifier, Consent.status, Consent.status.extension, Consent.status.extension:status, Consent.scope, Consent.category, Consent.patient, Consent.patient.extension, Consent.patient.extension:subject, Consent.patient.reference, Consent.patient.type, Consent.patient.identifier, Consent.patient.display, Consent.dateTime, Consent.performer, Consent.performer.extension, Consent.performer.extension:grantee, Consent.performer.reference, Consent.performer.type, Consent.performer.identifier, Consent.performer.display, Consent.organization, Consent.source[x], Consent.source[x].extension, Consent.source[x].extension:alternateReference, Consent.policy, Consent.policy.extension, Consent.policy.modifierExtension, Consent.policy.authority, Consent.policy.uri, Consent.policyRule, Consent.verification, Consent.verification.extension, Consent.verification.extension:verificationType, Consent.verification.extension:verifiedBy, Consent.verification.modifierExtension, Consent.verification.verified, Consent.verification.verifiedWith, Consent.verification.verificationDate, Consent.provision, Consent.provision.extension, Consent.provision.extension:expression, Consent.provision.modifierExtension, Consent.provision.type, Consent.provision.period, Consent.provision.actor, Consent.provision.actor.extension, Consent.provision.actor.modifierExtension, Consent.provision.actor.role, Consent.provision.actor.reference, Consent.provision.action, Consent.provision.securityLabel, Consent.provision.purpose, Consent.provision.class, Consent.provision.code, Consent.provision.dataPeriod, Consent.provision.data, Consent.provision.data.extension, Consent.provision.data.modifierExtension, Consent.provision.data.meaning, Consent.provision.data.reference, Consent.provision.provision	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	Consent.extension, Consent.extension:period, Consent.extension:grantor, Consent.extension:manager, Consent.extension:controller, Consent.extension:policyText, Consent.modifierExtension, Consent.modifierExtension:decision, Consent.status.extension, Consent.status.extension:status, Consent.patient.extension, Consent.patient.extension:subject, Consent.performer.extension, Consent.performer.extension:grantee, Consent.source[x].extension, Consent.source[x].extension:alternateReference, Consent.policy.extension, Consent.policy.modifierExtension, Consent.verification.extension, Consent.verification.extension:verificationType, Consent.verification.extension:verifiedBy, Consent.verification.modifierExtension, Consent.provision.extension, Consent.provision.extension:expression, Consent.provision.modifierExtension, Consent.provision.actor.extension, Consent.provision.actor.modifierExtension, Consent.provision.data.extension, Consent.provision.data.modifierExtension	Must have either extensions or value[x], not both	extension.exists() != value.exists()
ppc-1	error	Consent	Either a Policy or PolicyRule	policy.exists() or policyRule.exists()
ppc-2	error	Consent	IF Scope=privacy, there must be a patient	patient.exists() or scope.coding.where(system='something' and code='patient-privacy').exists().not()
ppc-3	error	Consent	IF Scope=research, there must be a patient	patient.exists() or scope.coding.where(system='something' and code='research').exists().not()
ppc-4	error	Consent	IF Scope=adr, there must be a patient	patient.exists() or scope.coding.where(system='something' and code='adr').exists().not()
ppc-5	error	Consent	IF Scope=treatment, there must be a patient	patient.exists() or scope.coding.where(system='something' and code='treatment').exists().not()

This structure is derived from Profile_R5_Consent_R4

Summary

Mandatory: 3 elements
Prohibited: 3 elements

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Consent	C	0..*	Profile_R5_Consent_R4	A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time Constraints: ppc-1, ppc-2, ppc-3, ppc-4, ppc-5
Consent.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Consent.Slices for extension				Content/Rules for all slices
Consent.Slices for extension.extension:period		0..1	Period	R5: Effective period for this Consent (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.period Constraints: ext-1
Consent.Slices for extension.extension:grantor		0..*	(Complex)	R5: Who is granting rights according to the policy and rules (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor Constraints: ext-1
Consent.Slices for extension.extension:grantor.extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Consent.Slices for extension.extension:grantor.url		1..1	uri	"http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor"
Consent.Slices for extension.extension:grantor.value[x]		0..1	Reference(Patient | RelatedPerson | Organization)	Who is granting rights according to the policy and rules
Consent.Slices for extension.extension:manager		0..*	(Complex)	R5: Consent workflow management (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.manager Constraints: ext-1
Consent.Slices for extension.extension:manager.extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Consent.Slices for extension.extension:manager.url		1..1	uri	"http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.manager"
Consent.Slices for extension.extension:manager.value[x]		0..1	Reference(HealthcareService)	Consent workflow management
Consent.Slices for extension.extension:controller		0..*	(Complex)	R5: Consent Enforcer (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.controller Constraints: ext-1
Consent.Slices for extension.extension:controller.extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Consent.Slices for extension.extension:controller.url		1..1	uri	"http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.controller"
Consent.Slices for extension.extension:controller.value[x]		0..1	Reference(Organization)	Consent Enforcer
Consent.Slices for extension.extension:policyText		0..*	Reference(Cross-version Profile for R5.DocumentReference for use in FHIR R4(0.1.0) | Media)	R5: Human Readable Policy (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.policyText Constraints: ext-1
Consent.Slices for modifierExtension	?! This element is a modifier element.	0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
Consent.Slices for modifierExtension.modifierExtension:decision	?! This element is a modifier element.	0..1	code	R5: deny | permit (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.decision 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. Constraints: ext-1
Consent.status	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent.
Consent.status.Slices for extension				Content/Rules for all slices
Consent.status.Slices for extension.extension:status		0..1	code	R5: draft | active | inactive | not-done | entered-in-error | unknown URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.status Binding: R5ConsentStateCodesForR4 (0.1.0) (required): Indicates the state of the consent. Constraints: ext-1
Consent.scope	?! This element is a modifier element. Σ This element is included in summaries.	1..1	CodeableConcept	Which of the four areas this resource covers (extensible) Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource.
Consent.category	Σ This element is included in summaries.	1..*	CodeableConcept	Initial classification of consent, used with provision.code to identify consent types Binding: ConsentCategoriesVS (required)
Consent.patient	Σ This element is included in summaries.	1..1	Reference(Patient)	The patient to whom this consent applies to
Consent.patient.Slices for extension				Content/Rules for all slices
Consent.patient.Slices for extension.extension:subject		0..1	Reference(Resource)	R5: subject URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1
Consent.performer	Σ This element is included in summaries.	0..*	Reference(Organization)	Grantee (Organization). For HealthcareService grantees, use the alternate-reference extension on performer.
Consent.performer.Slices for extension				Content/Rules for all slices
Consent.performer.Slices for extension.extension:grantee		0..1	Reference(Resource)	R5: grantee URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1
Consent.provision	Σ This element is included in summaries.	1..1	BackboneElement	Exceptions/Constraints to the base decision
Consent.provision.Slices for extension				Content/Rules for all slices
Consent.provision.Slices for extension.extension:expression		0..1	Expression	R5: A computable expression of the consent (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.provision.expression Constraints: ext-1
Consent.provision.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
Consent.provision.code	Σ This element is included in summaries.	1..*	CodeableConcept	Additional classification of consent, used with category to identify consent types Binding: ConsentProvisionCodesVS (required)
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Consent.status	Base	required	ConsentState	📍4.0.1	FHIR Std.
Consent.scope	Base	extensible	Consent Scope Codes	📍4.0.1	FHIR Std.
Consent.category	Base	required	ConsentCategoriesVS	📦7.0.0-ballot	This IG
Consent.provision.code	Base	required	ConsentProvisionCodesVS	📦7.0.0-ballot	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	Consent	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Consent	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Consent	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Consent	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Consent	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	Consent.implicitRules, Consent.extension:period, Consent.extension:grantor, Consent.extension:grantor.value[x], Consent.extension:manager, Consent.extension:manager.value[x], Consent.extension:controller, Consent.extension:controller.value[x], Consent.extension:policyText, Consent.modifierExtension, Consent.modifierExtension:decision, Consent.status, Consent.status.extension:status, Consent.scope, Consent.category, Consent.patient, Consent.patient.extension:subject, Consent.performer, Consent.performer.extension:grantee, Consent.provision, Consent.provision.extension:expression, Consent.provision.modifierExtension, Consent.provision.code	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	Consent.extension:period, Consent.extension:grantor, Consent.extension:manager, Consent.extension:controller, Consent.extension:policyText, Consent.modifierExtension, Consent.modifierExtension:decision, Consent.status.extension:status, Consent.patient.extension:subject, Consent.performer.extension:grantee, Consent.provision.extension:expression, Consent.provision.modifierExtension	Must have either extensions or value[x], not both	extension.exists() != value.exists()
ppc-1	error	Consent	Either a Policy or PolicyRule	policy.exists() or policyRule.exists()
ppc-2	error	Consent	IF Scope=privacy, there must be a patient	patient.exists() or scope.coding.where(system='something' and code='patient-privacy').exists().not()
ppc-3	error	Consent	IF Scope=research, there must be a patient	patient.exists() or scope.coding.where(system='something' and code='research').exists().not()
ppc-4	error	Consent	IF Scope=adr, there must be a patient	patient.exists() or scope.coding.where(system='something' and code='adr').exists().not()
ppc-5	error	Consent	IF Scope=treatment, there must be a patient	patient.exists() or scope.coding.where(system='something' and code='treatment').exists().not()

Differential View

This structure is derived from Profile_R5_Consent_R4

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Consent		0..*	Profile_R5_Consent_R4	A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
Consent.Slices for extension				Content/Rules for all slices
Consent.Slices for extension.extension:grantor		0..*	0.1.0	R5: Who is granting rights according to the policy and rules (new)
Consent.Slices for extension.extension:grantor.extension		0..0		Extension
Consent.Slices for extension.extension:grantor.value[x]		0..1	Reference(Patient | RelatedPerson | Organization)	Who is granting rights according to the policy and rules
Consent.Slices for extension.extension:manager		0..*	0.1.0	R5: Consent workflow management (new)
Consent.Slices for extension.extension:manager.extension		0..0		Extension
Consent.Slices for extension.extension:manager.value[x]		0..1	Reference(HealthcareService)	Consent workflow management
Consent.Slices for extension.extension:controller		0..*	0.1.0	R5: Consent Enforcer (new)
Consent.Slices for extension.extension:controller.extension		0..0		Extension
Consent.Slices for extension.extension:controller.value[x]		0..1	Reference(Organization)	Consent Enforcer
Consent.category		1..*	CodeableConcept	Initial classification of consent, used with provision.code to identify consent types Binding: ConsentCategoriesVS (required)
Consent.patient		1..1	Reference(Patient)	The patient to whom this consent applies to
Consent.performer		0..*	Reference(Organization)	Grantee (Organization). For HealthcareService grantees, use the alternate-reference extension on performer.
Consent.provision		1..1	BackboneElement	Exceptions/Constraints to the base decision
Consent.provision.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	Status	Usage	ValueSet	Version	Source
Consent.category	Base	required	ConsentCategoriesVS	📦7.0.0-ballot	This IG
Consent.provision.code	Base	required	ConsentProvisionCodesVS	📦7.0.0-ballot	This IG

Snapshot ViewView

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Consent	C	0..*	Profile_R5_Consent_R4	A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time Constraints: ppc-1, ppc-2, ppc-3, ppc-4, ppc-5
Consent.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
Consent.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Consent.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Consent.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Consent.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
Consent.contained		0..*	Resource	Contained, inline Resources
Consent.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
Consent.Slices for extension.extension:period		0..1	Period	R5: Effective period for this Consent (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.period Constraints: ext-1
Consent.Slices for extension.extension:grantor		0..*	(Complex)	R5: Who is granting rights according to the policy and rules (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor Constraints: ext-1
Consent.Slices for extension.extension:grantor.id		0..1	string	Unique id for inter-element referencing
Consent.Slices for extension.extension:grantor.extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Consent.Slices for extension.extension:grantor.url		1..1	uri	"http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor"
Consent.Slices for extension.extension:grantor.value[x]		0..1	Reference(Patient | RelatedPerson | Organization)	Who is granting rights according to the policy and rules
Consent.Slices for extension.extension:manager		0..*	(Complex)	R5: Consent workflow management (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.manager Constraints: ext-1
Consent.Slices for extension.extension:manager.id		0..1	string	Unique id for inter-element referencing
Consent.Slices for extension.extension:manager.extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Consent.Slices for extension.extension:manager.url		1..1	uri	"http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.manager"
Consent.Slices for extension.extension:manager.value[x]		0..1	Reference(HealthcareService)	Consent workflow management
Consent.Slices for extension.extension:controller		0..*	(Complex)	R5: Consent Enforcer (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.controller Constraints: ext-1
Consent.Slices for extension.extension:controller.id		0..1	string	Unique id for inter-element referencing
Consent.Slices for extension.extension:controller.extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Consent.Slices for extension.extension:controller.url		1..1	uri	"http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.controller"
Consent.Slices for extension.extension:controller.value[x]		0..1	Reference(Organization)	Consent Enforcer
Consent.Slices for extension.extension:policyText		0..*	Reference(Cross-version Profile for R5.DocumentReference for use in FHIR R4(0.1.0) | Media)	R5: Human Readable Policy (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.policyText Constraints: ext-1
Consent.Slices for modifierExtension	?! This element is a modifier element.	0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
Consent.Slices for modifierExtension.modifierExtension:decision	?! This element is a modifier element.	0..1	code	R5: deny | permit (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.decision 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. Constraints: ext-1
Consent.identifier	Σ This element is included in summaries.	0..*	Identifier	Identifier for this record (external references) Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"}
Consent.status	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent.
Consent.status.id		0..1	string	xml:id (or equivalent in JSON)
Consent.status.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
Consent.status.Slices for extension.extension:status		0..1	code	R5: draft | active | inactive | not-done | entered-in-error | unknown URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.status Binding: R5ConsentStateCodesForR4 (0.1.0) (required): Indicates the state of the consent. Constraints: ext-1
Consent.status.value		0..1	string	Primitive value for code
Consent.scope	?! This element is a modifier element. Σ This element is included in summaries.	1..1	CodeableConcept	Which of the four areas this resource covers (extensible) Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource.
Consent.category	Σ This element is included in summaries.	1..*	CodeableConcept	Initial classification of consent, used with provision.code to identify consent types Binding: ConsentCategoriesVS (required)
Consent.patient	Σ This element is included in summaries.	1..1	Reference(Patient)	The patient to whom this consent applies to
Consent.patient.id		0..1	string	Unique id for inter-element referencing
Consent.patient.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
Consent.patient.Slices for extension.extension:subject		0..1	Reference(Resource)	R5: subject URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1
Consent.patient.reference	Σ This element is included in summaries. C	0..1	string	Literal reference, Relative, internal or absolute URL
Consent.patient.type	Σ This element is included in summaries.	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Consent.patient.identifier	Σ This element is included in summaries.	0..1	Identifier	Logical reference, when literal reference is not known
Consent.patient.display	Σ This element is included in summaries.	0..1	string	Text alternative for the resource
Consent.dateTime	Σ This element is included in summaries.	0..1	dateTime	When this Consent was created or indexed
Consent.performer	Σ This element is included in summaries.	0..*	Reference(Organization)	Grantee (Organization). For HealthcareService grantees, use the alternate-reference extension on performer.
Consent.performer.id		0..1	string	Unique id for inter-element referencing
Consent.performer.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
Consent.performer.Slices for extension.extension:grantee		0..1	Reference(Resource)	R5: grantee URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1
Consent.performer.reference	Σ This element is included in summaries. C	0..1	string	Literal reference, Relative, internal or absolute URL
Consent.performer.type	Σ This element is included in summaries.	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Consent.performer.identifier	Σ This element is included in summaries.	0..1	Identifier	Logical reference, when literal reference is not known
Consent.performer.display	Σ This element is included in summaries.	0..1	string	Text alternative for the resource
Consent.organization	Σ This element is included in summaries.	0..*	Reference(Organization)	Custodian of the consent
Consent.source[x]	Σ This element is included in summaries.	0..1		Source from which this consent is taken
Consent.source[x].source[x]All Types				Content/Rules for all Types
Consent.source[x].source[x]All Types.id		0..1	string	Unique id for inter-element referencing
Consent.source[x].source[x]All Types.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
Consent.source[x].source[x]All Types.Slices for extension.extension:alternateReference		0..1	Reference(Resource)	R5: sourceReference URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1
Consent.source[x].sourceAttachment			Attachment
Consent.source[x].sourceReference			Reference(Consent | DocumentReference | Contract | QuestionnaireResponse)
Consent.policy		0..*	BackboneElement	Policies covered by this consent
Consent.policy.id		0..1	string	Unique id for inter-element referencing
Consent.policy.extension		0..*	Extension	Additional content defined by implementations Constraints: ext-1
Consent.policy.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
Consent.policy.authority	C	0..1	uri	Enforcement source for policy
Consent.policy.uri	C	0..1	uri	Specific policy covered by this consent
Consent.policyRule	Σ This element is included in summaries. C	0..1	CodeableConcept	Regulation that this consents to Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples.
Consent.verification	Σ This element is included in summaries.	0..*	BackboneElement	Consent Verified by patient or family
Consent.verification.id		0..1	string	Unique id for inter-element referencing
Consent.verification.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
Consent.verification.Slices for extension.extension:verificationType		0..1	CodeableConcept	R5: Business case of verification (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.verification.verificationType Binding: R5ConsentVerificationForR4 (0.1.0) (example): Types of Verification/Validation. Constraints: ext-1
Consent.verification.Slices for extension.extension:verifiedBy		0..1	Reference(Cross-version Profile for R5.Organization for use in FHIR R4(0.1.0) | Organization | Cross-version Profile for R5.Practitioner for use in FHIR R4(0.1.0) | Practitioner | Cross-version Profile for R5.PractitionerRole for use in FHIR R4(0.1.0) | PractitionerRole)	R5: Person conducting verification (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.verification.verifiedBy Constraints: ext-1
Consent.verification.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
Consent.verification.verified	Σ This element is included in summaries.	1..1	boolean	Has been verified
Consent.verification.verifiedWith		0..1	Reference(Patient | RelatedPerson)	Person who verified
Consent.verification.verificationDate		0..1	dateTime	When consent verified
Consent.provision	Σ This element is included in summaries.	1..1	BackboneElement	Exceptions/Constraints to the base decision
Consent.provision.id		0..1	string	Unique id for inter-element referencing
Consent.provision.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
Consent.provision.Slices for extension.extension:expression		0..1	Expression	R5: A computable expression of the consent (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.provision.expression Constraints: ext-1
Consent.provision.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
Consent.provision.type	Σ This element is included in summaries.	0..1	code	deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent.
Consent.provision.period	Σ This element is included in summaries.	0..1	Period	Timeframe for this rule
Consent.provision.actor		0..*	BackboneElement	Who|what controlled by this rule (or group, by role)
Consent.provision.actor.id		0..1	string	Unique id for inter-element referencing
Consent.provision.actor.extension		0..*	Extension	Additional content defined by implementations Constraints: ext-1
Consent.provision.actor.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
Consent.provision.actor.role		1..1	CodeableConcept	How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.
Consent.provision.actor.reference		1..1	Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole)	Resource for the actor (or group, by role)
Consent.provision.action	Σ This element is included in summaries.	0..*	CodeableConcept	Actions controlled by this rule Binding: ConsentActionCodes (example): Detailed codes for the consent action.
Consent.provision.securityLabel	Σ This element is included in summaries.	0..*	Coding	Security Labels that define affected resources Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Consent.provision.purpose	Σ This element is included in summaries.	0..*	Coding	Context of activities covered by this rule Binding: PurposeOfUse (3.1.0) (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels.
Consent.provision.class	Σ This element is included in summaries.	0..*	Coding	e.g. Resource Type, Profile, CDA, etc. Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers.
Consent.provision.code	Σ This element is included in summaries.	1..*	CodeableConcept	Additional classification of consent, used with category to identify consent types Binding: ConsentProvisionCodesVS (required)
Consent.provision.dataPeriod	Σ This element is included in summaries.	0..1	Period	Timeframe for data controlled by this rule
Consent.provision.data	Σ This element is included in summaries.	0..*	BackboneElement	Data controlled by this rule
Consent.provision.data.id		0..1	string	Unique id for inter-element referencing
Consent.provision.data.extension		0..*	Extension	Additional content defined by implementations Constraints: ext-1
Consent.provision.data.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
Consent.provision.data.meaning	Σ This element is included in summaries.	1..1	code	instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions.
Consent.provision.data.reference	Σ This element is included in summaries.	1..1	Reference(Resource)	The actual data reference
Consent.provision.provision		0..*	See provision (Consent)	Nested Exception Rules
Documentation for this format

Terminology Bindings

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

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	Consent	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Consent	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Consent	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Consent	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Consent	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	Consent.meta, Consent.implicitRules, Consent.language, Consent.text, Consent.extension, Consent.extension:period, Consent.extension:grantor, Consent.extension:grantor.value[x], Consent.extension:manager, Consent.extension:manager.value[x], Consent.extension:controller, Consent.extension:controller.value[x], Consent.extension:policyText, Consent.modifierExtension, Consent.modifierExtension:decision, Consent.identifier, Consent.status, Consent.status.extension, Consent.status.extension:status, Consent.scope, Consent.category, Consent.patient, Consent.patient.extension, Consent.patient.extension:subject, Consent.patient.reference, Consent.patient.type, Consent.patient.identifier, Consent.patient.display, Consent.dateTime, Consent.performer, Consent.performer.extension, Consent.performer.extension:grantee, Consent.performer.reference, Consent.performer.type, Consent.performer.identifier, Consent.performer.display, Consent.organization, Consent.source[x], Consent.source[x].extension, Consent.source[x].extension:alternateReference, Consent.policy, Consent.policy.extension, Consent.policy.modifierExtension, Consent.policy.authority, Consent.policy.uri, Consent.policyRule, Consent.verification, Consent.verification.extension, Consent.verification.extension:verificationType, Consent.verification.extension:verifiedBy, Consent.verification.modifierExtension, Consent.verification.verified, Consent.verification.verifiedWith, Consent.verification.verificationDate, Consent.provision, Consent.provision.extension, Consent.provision.extension:expression, Consent.provision.modifierExtension, Consent.provision.type, Consent.provision.period, Consent.provision.actor, Consent.provision.actor.extension, Consent.provision.actor.modifierExtension, Consent.provision.actor.role, Consent.provision.actor.reference, Consent.provision.action, Consent.provision.securityLabel, Consent.provision.purpose, Consent.provision.class, Consent.provision.code, Consent.provision.dataPeriod, Consent.provision.data, Consent.provision.data.extension, Consent.provision.data.modifierExtension, Consent.provision.data.meaning, Consent.provision.data.reference, Consent.provision.provision	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	Consent.extension, Consent.extension:period, Consent.extension:grantor, Consent.extension:manager, Consent.extension:controller, Consent.extension:policyText, Consent.modifierExtension, Consent.modifierExtension:decision, Consent.status.extension, Consent.status.extension:status, Consent.patient.extension, Consent.patient.extension:subject, Consent.performer.extension, Consent.performer.extension:grantee, Consent.source[x].extension, Consent.source[x].extension:alternateReference, Consent.policy.extension, Consent.policy.modifierExtension, Consent.verification.extension, Consent.verification.extension:verificationType, Consent.verification.extension:verifiedBy, Consent.verification.modifierExtension, Consent.provision.extension, Consent.provision.extension:expression, Consent.provision.modifierExtension, Consent.provision.actor.extension, Consent.provision.actor.modifierExtension, Consent.provision.data.extension, Consent.provision.data.modifierExtension	Must have either extensions or value[x], not both	extension.exists() != value.exists()
ppc-1	error	Consent	Either a Policy or PolicyRule	policy.exists() or policyRule.exists()
ppc-2	error	Consent	IF Scope=privacy, there must be a patient	patient.exists() or scope.coding.where(system='something' and code='patient-privacy').exists().not()
ppc-3	error	Consent	IF Scope=research, there must be a patient	patient.exists() or scope.coding.where(system='something' and code='research').exists().not()
ppc-4	error	Consent	IF Scope=adr, there must be a patient	patient.exists() or scope.coding.where(system='something' and code='adr').exists().not()
ppc-5	error	Consent	IF Scope=treatment, there must be a patient	patient.exists() or scope.coding.where(system='something' and code='treatment').exists().not()

This structure is derived from Profile_R5_Consent_R4

Summary

Mandatory: 3 elements
Prohibited: 3 elements

Other representations of profile: CSV, Excel, Schematron