HL7 Belgium Patientwill (Patient Dossier), published by eHealth Platform. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-be/patientwill/ and changes regularly. See the Directory of published versions

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

Resource Profile: BePatientWill

Belgian federal profile for a patient will ONLY in the context of the patient will in the context of limitations to treatment, DNR etc. Initially based on the functional description of the NIHDI. This profile will in the future be also used to record agreement to participate in clinical trials etc. Any usecase around informed consent is out of scope for this profile.

Usages:

• Examples for this Profile: Consent/patientwill1

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Consent	C	0..*	Consent	A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time Constraints: ppc-1, ppc-2, ppc-3, ppc-4, ppc-5
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:note	S	0..1	Annotation	BeExtSimpleNote URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-simple-note
extension:recorder	S	1..1	Reference(BePatient | BePractitioner | BeOrganization | BePractitionerRole)	BeExtRecorder URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-recorder
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..*	Identifier	Identifier for this record (external references) Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"}
status	?!SΣ	1..1	code	This is the status of the patient will expressed under provision.code . Binding: ConsentState (required): Indicates the state of the consent.
scope	?!Σ	1..1	CodeableConcept	Scope is not explicit in the Belgian context Binding: BeVSPatientWillScope (extensible)
category	SΣ	1..*	CodeableConcept	Classification of the consent statement - for indexing/retrieval Binding: Patient Will Category (required)
patient	SΣ	1..1	Reference(BePatient)	The subject of the patient will.
dateTime	SΣ	1..1	dateTime	The dateTime when the patient will has been recorded
performer	SΣ	0..*	Reference(BeOrganization | BePatient | BePractitioner | BePractitionerRole | RelatedPerson)	Commonly, the patient will is expressed by the patient, but for some cases it may be some other person. See representative in the LM
Slices for source[x]	SΣ	0..1		The evidence used to support the patient will. Slice: Unordered, Open by type:$this
sourceAttachment			Attachment
sourceReference			Reference(Consent | DocumentReference | Contract | QuestionnaireResponse)
source[x]:sourceReference	Σ	0..1	Reference(DocumentReference)	Source from which this consent is taken
provision	SΣ	1..1	BackboneElement	Constraints to the base Consent.policyRule
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
period	SΣ	1..1	Period	Timeframe for this rule
code	SΣ	1..1	CodeableConcept	The actual directive in the will Binding: Patient Will code Value Set (extensible)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Consent.status	required	ConsentState http://hl7.org/fhir/ValueSet/consent-state-codes|4.0.1 From the FHIR Standard
Consent.scope	extensible	BeVSPatientWillScope https://www.ehealth.fgov.be/standards/fhir/patientwill/ValueSet/be-vs-patientwill-scope From this IG
Consent.category	required	BeVSPatientWillCategory(a valid code from Patient Will Category CodeSystem) https://www.ehealth.fgov.be/standards/fhir/patientwill/ValueSet/be-vs-patientwill-category From this IG
Consent.provision.code	extensible	BeVSPatientWillCode(a valid code from Patient Will Directive CodeSystem) https://www.ehealth.fgov.be/standards/fhir/patientwill/ValueSet/be-vs-patientwill-code From this IG
Consent.provision.data.meaning	required	ConsentDataMeaning http://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Consent	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Consent	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Consent	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
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 Consent

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Consent		0..*	Consent	A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:note	S	0..1	Annotation	BeExtSimpleNote URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-simple-note
extension:recorder	S	1..1	Reference(BePatient | BePractitioner | BeOrganization | BePractitionerRole)	BeExtRecorder URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-recorder
identifier	S	0..*	Identifier	Identifier for this record (external references)
status	S	1..1	code	This is the status of the patient will expressed under provision.code .
scope		1..1	CodeableConcept	Scope is not explicit in the Belgian context Binding: BeVSPatientWillScope (extensible)
category	S	1..*	CodeableConcept	Classification of the consent statement - for indexing/retrieval Binding: Patient Will Category (required)
patient	S	1..1	Reference(BePatient)	The subject of the patient will.
dateTime	S	1..1	dateTime	The dateTime when the patient will has been recorded
performer	S	0..*	Reference(BeOrganization | BePatient | BePractitioner | BePractitionerRole | RelatedPerson)	Commonly, the patient will is expressed by the patient, but for some cases it may be some other person. See representative in the LM
Slices for source[x]	S	0..1	Attachment, Reference(Consent | DocumentReference | Contract | QuestionnaireResponse)	The evidence used to support the patient will. Slice: Unordered, Open by type:$this
source[x]:sourceReference		0..1	Reference(DocumentReference)	Source from which this consent is taken
provision	S	1..1	BackboneElement	Constraints to the base Consent.policyRule
period	S	1..1	Period	Timeframe for this rule
securityLabel		0..0
purpose		0..0
class		0..0
code	S	1..1	CodeableConcept	The actual directive in the will Binding: Patient Will code Value Set (extensible)
data		0..0
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Consent.scope	extensible	BeVSPatientWillScope https://www.ehealth.fgov.be/standards/fhir/patientwill/ValueSet/be-vs-patientwill-scope From this IG
Consent.category	required	BeVSPatientWillCategory(a valid code from Patient Will Category CodeSystem) https://www.ehealth.fgov.be/standards/fhir/patientwill/ValueSet/be-vs-patientwill-category From this IG
Consent.provision.code	extensible	BeVSPatientWillCode(a valid code from Patient Will Directive CodeSystem) https://www.ehealth.fgov.be/standards/fhir/patientwill/ValueSet/be-vs-patientwill-code From this IG

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Consent	C	0..*	Consent	A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time Constraints: ppc-1, ppc-2, ppc-3, ppc-4, ppc-5
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:note	S	0..1	Annotation	BeExtSimpleNote URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-simple-note
extension:recorder	S	1..1	Reference(BePatient | BePractitioner | BeOrganization | BePractitionerRole)	BeExtRecorder URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-recorder
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..*	Identifier	Identifier for this record (external references) Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"}
status	?!SΣ	1..1	code	This is the status of the patient will expressed under provision.code . Binding: ConsentState (required): Indicates the state of the consent.
scope	?!Σ	1..1	CodeableConcept	Scope is not explicit in the Belgian context Binding: BeVSPatientWillScope (extensible)
category	SΣ	1..*	CodeableConcept	Classification of the consent statement - for indexing/retrieval Binding: Patient Will Category (required)
patient	SΣ	1..1	Reference(BePatient)	The subject of the patient will.
dateTime	SΣ	1..1	dateTime	The dateTime when the patient will has been recorded
performer	SΣ	0..*	Reference(BeOrganization | BePatient | BePractitioner | BePractitionerRole | RelatedPerson)	Commonly, the patient will is expressed by the patient, but for some cases it may be some other person. See representative in the LM
organization	Σ	0..*	Reference(Organization)	Custodian of the consent
Slices for source[x]	SΣ	0..1		The evidence used to support the patient will. Slice: Unordered, Open by type:$this
sourceAttachment			Attachment
sourceReference			Reference(Consent | DocumentReference | Contract | QuestionnaireResponse)
source[x]:sourceReference	Σ	0..1	Reference(DocumentReference)	Source from which this consent is taken
policy		0..*	BackboneElement	Policies covered by this consent
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
authority	C	0..1	uri	Enforcement source for policy
uri	C	0..1	uri	Specific policy covered by this consent
policyRule	ΣC	0..1	CodeableConcept	Regulation that this consents to Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples.
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
verifiedWith		0..1	Reference(Patient | RelatedPerson)	Person who verified
verificationDate		0..1	dateTime	When consent verified
provision	SΣ	1..1	BackboneElement	Constraints to the base Consent.policyRule
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	0..1	code	deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent.
period	SΣ	1..1	Period	Timeframe for this rule
actor		0..*	BackboneElement	Who|what controlled by this rule (or group, by role)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
role		1..1	CodeableConcept	How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.
reference		1..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 rule Binding: ConsentActionCodes (example): Detailed codes for the consent action.
code	SΣ	1..1	CodeableConcept	The actual directive in the will Binding: Patient Will code Value Set (extensible)
dataPeriod	Σ	0..1	Period	Timeframe for data controlled by this rule
provision		0..*	See provision (Consent)	Nested Exception Rules
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Consent.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Consent.status	required	ConsentState http://hl7.org/fhir/ValueSet/consent-state-codes|4.0.1 From the FHIR Standard
Consent.scope	extensible	BeVSPatientWillScope https://www.ehealth.fgov.be/standards/fhir/patientwill/ValueSet/be-vs-patientwill-scope From this IG
Consent.category	required	BeVSPatientWillCategory(a valid code from Patient Will Category CodeSystem) https://www.ehealth.fgov.be/standards/fhir/patientwill/ValueSet/be-vs-patientwill-category From this IG
Consent.policyRule	extensible	ConsentPolicyRuleCodes http://hl7.org/fhir/ValueSet/consent-policy From the FHIR Standard
Consent.provision.type	required	ConsentProvisionType http://hl7.org/fhir/ValueSet/consent-provision-type|4.0.1 From the FHIR Standard
Consent.provision.actor.role	extensible	SecurityRoleType http://hl7.org/fhir/ValueSet/security-role-type From the FHIR Standard
Consent.provision.action	example	ConsentActionCodes http://hl7.org/fhir/ValueSet/consent-action From the FHIR Standard
Consent.provision.code	extensible	BeVSPatientWillCode(a valid code from Patient Will Directive CodeSystem) https://www.ehealth.fgov.be/standards/fhir/patientwill/ValueSet/be-vs-patientwill-code From this IG
Consent.provision.data.meaning	required	ConsentDataMeaning http://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Consent	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Consent	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Consent	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
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 Consent

Summary

Mandatory: 7 elements
Must-Support: 12 elements
Prohibited: 4 elements

Structures

This structure refers to these other structures:

• BePatient (https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-patient)
• BeOrganization (https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-organization)
• BePractitioner (https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-practitioner)
• BePractitionerRole (https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-practitionerrole)

Extensions

This structure refers to these extensions:

• https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-simple-note
• https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-recorder

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Consent.source[x]

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Consent	C	0..*	Consent	A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time Constraints: ppc-1, ppc-2, ppc-3, ppc-4, ppc-5
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:note	S	0..1	Annotation	BeExtSimpleNote URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-simple-note
extension:recorder	S	1..1	Reference(BePatient | BePractitioner | BeOrganization | BePractitionerRole)	BeExtRecorder URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-recorder
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..*	Identifier	Identifier for this record (external references) Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"}
status	?!SΣ	1..1	code	This is the status of the patient will expressed under provision.code . Binding: ConsentState (required): Indicates the state of the consent.
scope	?!Σ	1..1	CodeableConcept	Scope is not explicit in the Belgian context Binding: BeVSPatientWillScope (extensible)
category	SΣ	1..*	CodeableConcept	Classification of the consent statement - for indexing/retrieval Binding: Patient Will Category (required)
patient	SΣ	1..1	Reference(BePatient)	The subject of the patient will.
dateTime	SΣ	1..1	dateTime	The dateTime when the patient will has been recorded
performer	SΣ	0..*	Reference(BeOrganization | BePatient | BePractitioner | BePractitionerRole | RelatedPerson)	Commonly, the patient will is expressed by the patient, but for some cases it may be some other person. See representative in the LM
Slices for source[x]	SΣ	0..1		The evidence used to support the patient will. Slice: Unordered, Open by type:$this
sourceAttachment			Attachment
sourceReference			Reference(Consent | DocumentReference | Contract | QuestionnaireResponse)
source[x]:sourceReference	Σ	0..1	Reference(DocumentReference)	Source from which this consent is taken
provision	SΣ	1..1	BackboneElement	Constraints to the base Consent.policyRule
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
period	SΣ	1..1	Period	Timeframe for this rule
code	SΣ	1..1	CodeableConcept	The actual directive in the will Binding: Patient Will code Value Set (extensible)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Consent.status	required	ConsentState http://hl7.org/fhir/ValueSet/consent-state-codes|4.0.1 From the FHIR Standard
Consent.scope	extensible	BeVSPatientWillScope https://www.ehealth.fgov.be/standards/fhir/patientwill/ValueSet/be-vs-patientwill-scope From this IG
Consent.category	required	BeVSPatientWillCategory(a valid code from Patient Will Category CodeSystem) https://www.ehealth.fgov.be/standards/fhir/patientwill/ValueSet/be-vs-patientwill-category From this IG
Consent.provision.code	extensible	BeVSPatientWillCode(a valid code from Patient Will Directive CodeSystem) https://www.ehealth.fgov.be/standards/fhir/patientwill/ValueSet/be-vs-patientwill-code From this IG
Consent.provision.data.meaning	required	ConsentDataMeaning http://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Consent	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Consent	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Consent	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
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 Consent

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Consent		0..*	Consent	A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:note	S	0..1	Annotation	BeExtSimpleNote URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-simple-note
extension:recorder	S	1..1	Reference(BePatient | BePractitioner | BeOrganization | BePractitionerRole)	BeExtRecorder URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-recorder
identifier	S	0..*	Identifier	Identifier for this record (external references)
status	S	1..1	code	This is the status of the patient will expressed under provision.code .
scope		1..1	CodeableConcept	Scope is not explicit in the Belgian context Binding: BeVSPatientWillScope (extensible)
category	S	1..*	CodeableConcept	Classification of the consent statement - for indexing/retrieval Binding: Patient Will Category (required)
patient	S	1..1	Reference(BePatient)	The subject of the patient will.
dateTime	S	1..1	dateTime	The dateTime when the patient will has been recorded
performer	S	0..*	Reference(BeOrganization | BePatient | BePractitioner | BePractitionerRole | RelatedPerson)	Commonly, the patient will is expressed by the patient, but for some cases it may be some other person. See representative in the LM
Slices for source[x]	S	0..1	Attachment, Reference(Consent | DocumentReference | Contract | QuestionnaireResponse)	The evidence used to support the patient will. Slice: Unordered, Open by type:$this
source[x]:sourceReference		0..1	Reference(DocumentReference)	Source from which this consent is taken
provision	S	1..1	BackboneElement	Constraints to the base Consent.policyRule
period	S	1..1	Period	Timeframe for this rule
securityLabel		0..0
purpose		0..0
class		0..0
code	S	1..1	CodeableConcept	The actual directive in the will Binding: Patient Will code Value Set (extensible)
data		0..0
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Consent.scope	extensible	BeVSPatientWillScope https://www.ehealth.fgov.be/standards/fhir/patientwill/ValueSet/be-vs-patientwill-scope From this IG
Consent.category	required	BeVSPatientWillCategory(a valid code from Patient Will Category CodeSystem) https://www.ehealth.fgov.be/standards/fhir/patientwill/ValueSet/be-vs-patientwill-category From this IG
Consent.provision.code	extensible	BeVSPatientWillCode(a valid code from Patient Will Directive CodeSystem) https://www.ehealth.fgov.be/standards/fhir/patientwill/ValueSet/be-vs-patientwill-code From this IG

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Consent	C	0..*	Consent	A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time Constraints: ppc-1, ppc-2, ppc-3, ppc-4, ppc-5
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:note	S	0..1	Annotation	BeExtSimpleNote URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-simple-note
extension:recorder	S	1..1	Reference(BePatient | BePractitioner | BeOrganization | BePractitionerRole)	BeExtRecorder URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-recorder
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..*	Identifier	Identifier for this record (external references) Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"}
status	?!SΣ	1..1	code	This is the status of the patient will expressed under provision.code . Binding: ConsentState (required): Indicates the state of the consent.
scope	?!Σ	1..1	CodeableConcept	Scope is not explicit in the Belgian context Binding: BeVSPatientWillScope (extensible)
category	SΣ	1..*	CodeableConcept	Classification of the consent statement - for indexing/retrieval Binding: Patient Will Category (required)
patient	SΣ	1..1	Reference(BePatient)	The subject of the patient will.
dateTime	SΣ	1..1	dateTime	The dateTime when the patient will has been recorded
performer	SΣ	0..*	Reference(BeOrganization | BePatient | BePractitioner | BePractitionerRole | RelatedPerson)	Commonly, the patient will is expressed by the patient, but for some cases it may be some other person. See representative in the LM
organization	Σ	0..*	Reference(Organization)	Custodian of the consent
Slices for source[x]	SΣ	0..1		The evidence used to support the patient will. Slice: Unordered, Open by type:$this
sourceAttachment			Attachment
sourceReference			Reference(Consent | DocumentReference | Contract | QuestionnaireResponse)
source[x]:sourceReference	Σ	0..1	Reference(DocumentReference)	Source from which this consent is taken
policy		0..*	BackboneElement	Policies covered by this consent
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
authority	C	0..1	uri	Enforcement source for policy
uri	C	0..1	uri	Specific policy covered by this consent
policyRule	ΣC	0..1	CodeableConcept	Regulation that this consents to Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples.
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
verifiedWith		0..1	Reference(Patient | RelatedPerson)	Person who verified
verificationDate		0..1	dateTime	When consent verified
provision	SΣ	1..1	BackboneElement	Constraints to the base Consent.policyRule
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	0..1	code	deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent.
period	SΣ	1..1	Period	Timeframe for this rule
actor		0..*	BackboneElement	Who|what controlled by this rule (or group, by role)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
role		1..1	CodeableConcept	How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.
reference		1..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 rule Binding: ConsentActionCodes (example): Detailed codes for the consent action.
code	SΣ	1..1	CodeableConcept	The actual directive in the will Binding: Patient Will code Value Set (extensible)
dataPeriod	Σ	0..1	Period	Timeframe for data controlled by this rule
provision		0..*	See provision (Consent)	Nested Exception Rules
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Consent.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Consent.status	required	ConsentState http://hl7.org/fhir/ValueSet/consent-state-codes|4.0.1 From the FHIR Standard
Consent.scope	extensible	BeVSPatientWillScope https://www.ehealth.fgov.be/standards/fhir/patientwill/ValueSet/be-vs-patientwill-scope From this IG
Consent.category	required	BeVSPatientWillCategory(a valid code from Patient Will Category CodeSystem) https://www.ehealth.fgov.be/standards/fhir/patientwill/ValueSet/be-vs-patientwill-category From this IG
Consent.policyRule	extensible	ConsentPolicyRuleCodes http://hl7.org/fhir/ValueSet/consent-policy From the FHIR Standard
Consent.provision.type	required	ConsentProvisionType http://hl7.org/fhir/ValueSet/consent-provision-type|4.0.1 From the FHIR Standard
Consent.provision.actor.role	extensible	SecurityRoleType http://hl7.org/fhir/ValueSet/security-role-type From the FHIR Standard
Consent.provision.action	example	ConsentActionCodes http://hl7.org/fhir/ValueSet/consent-action From the FHIR Standard
Consent.provision.code	extensible	BeVSPatientWillCode(a valid code from Patient Will Directive CodeSystem) https://www.ehealth.fgov.be/standards/fhir/patientwill/ValueSet/be-vs-patientwill-code From this IG
Consent.provision.data.meaning	required	ConsentDataMeaning http://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Consent	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Consent	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Consent	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
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 Consent

Summary

Mandatory: 7 elements
Must-Support: 12 elements
Prohibited: 4 elements

Structures

This structure refers to these other structures:

• BePatient (https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-patient)
• BeOrganization (https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-organization)
• BePractitioner (https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-practitioner)
• BePractitionerRole (https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-practitionerrole)

Extensions

This structure refers to these extensions:

• https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-simple-note
• https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-recorder

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Consent.source[x]

Other representations of profile: CSV, Excel, Schematron