Belgium eHealth FHIR Core specifications
1.2.2 - CI Build

This page is part of the Belgium eHealth FHIR Core specifications (v1.2.2: Trial Use) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: BePatientWill

Defining URL:https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-patientwill
Version:1.2.2
Name:BePatientWill
Status:Active as of 2021-01-10T10:59:49+00:00
Definition:

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.

Publisher:eHealth
Source Resource:XML / JSON / Turtle

The official URL for this profile is: 

https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-patientwill

Formal Views of Profile Content

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

This structure is derived from Consent

NameFlagsCard.TypeDescription & Constraintsdoco
.. Consent 0..*ConsentA healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
... identifier S0..*IdentifierIdentifier for this record (external references)
... status S1..1codedraft | proposed | active | rejected | inactive | entered-in-error
... scope S1..1CodeableConceptWhich of the four areas this resource covers (extensible)
... patient S1..1Reference(BePatient)The subject of the patient will.
... dateTime S1..1dateTimeThe dateTime when the patient will has been recorded
... performer S1..*Reference(BeOrganization | BePatient | BePractitioner | BePractitionerRole | RelatedPerson)Who is agreeing to the policy and rules
... source[x] S0..1Attachment, Reference(Consent | DocumentReference | Contract | QuestionnaireResponse)The evidence used to support the patient will.
... policyRule S1..1CodeableConceptRegulation that this consents to
.... text S0..1stringPlain text representation of the concept
Fixed Value: Belgian policy
... provision S1..1BackboneElementConstraints to the base Consent.policyRule
.... type S0..1codedeny | permit
.... period S1..1PeriodTimeframe for this rule
.... securityLabel 0..0
.... purpose 0..0
.... class 0..0
.... code S0..*CodeableConceptThe actual directive in the will
Binding: Patient Will code Value Set (required)
.... data 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Consent I0..*ConsentA healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierIdentifier for this record (external references)

Example General: {"system":"urn:ietf:rfc:3986","value":"Local eCMS identifier"}
... status ?!SΣ1..1codedraft | proposed | active | rejected | inactive | entered-in-error
Binding: ConsentState (required): Indicates the state of the consent.

... scope ?!SΣ1..1CodeableConceptWhich of the four areas this resource covers (extensible)
Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource.

... category SΣ1..*CodeableConceptClassification of the consent statement - for indexing/retrieval
Binding: Patient Will Category (required)
... patient SΣ1..1Reference(BePatient)The subject of the patient will.
... dateTime SΣ1..1dateTimeThe dateTime when the patient will has been recorded
... performer SΣ1..*Reference(BeOrganization | BePatient | BePractitioner | BePractitionerRole | RelatedPerson)Who is agreeing to the policy and rules
... organization Σ0..*Reference(Organization)Custodian of the consent
... source[x] SΣ0..1The evidence used to support the patient will.
.... sourceAttachmentAttachment
.... sourceReferenceReference(Consent | DocumentReference | Contract | QuestionnaireResponse)
... policy 0..*BackboneElementPolicies covered by this consent
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... authority I0..1uriEnforcement source for policy
.... uri I0..1uriSpecific policy covered by this consent
... policyRule SΣI1..1CodeableConceptRegulation that this consents to
Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples.

.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*CodingCode defined by a terminology system
.... text SΣ0..1stringPlain text representation of the concept
Fixed Value: Belgian policy
... verification Σ0..*BackboneElementConsent Verified by patient or family
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... verified Σ1..1booleanHas been verified
.... verifiedWith 0..1Reference(Patient | RelatedPerson)Person who verified
.... verificationDate 0..1dateTimeWhen consent verified
... provision SΣ1..1BackboneElementConstraints to the base Consent.policyRule
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type SΣ0..1codedeny | permit
Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent.

.... period SΣ1..1PeriodTimeframe for this rule
.... actor 0..*BackboneElementWho|what controlled by this rule (or group, by role)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... role 1..1CodeableConceptHow the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.

..... reference 1..1Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole)Resource for the actor (or group, by role)
.... action Σ0..*CodeableConceptActions controlled by this rule
Binding: ConsentActionCodes (example): Detailed codes for the consent action.


.... code SΣ0..*CodeableConceptThe actual directive in the will
Binding: Patient Will code Value Set (required)
.... dataPeriod Σ0..1PeriodTimeframe for data controlled by this rule
.... provision 0..*See provision (Consent)Nested Exception Rules

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Consent I0..*ConsentA healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
... identifier Σ0..*IdentifierIdentifier for this record (external references)
... status ?!Σ1..1codedraft | proposed | active | rejected | inactive | entered-in-error
Binding: ConsentState (required): Indicates the state of the consent.

... scope ?!Σ1..1CodeableConceptWhich of the four areas this resource covers (extensible)
Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource.

... patient Σ1..1Reference(BePatient)The subject of the patient will.
... dateTime Σ1..1dateTimeThe dateTime when the patient will has been recorded
... performer Σ1..*Reference(BeOrganization | BePatient | BePractitioner | BePractitionerRole | RelatedPerson)Who is agreeing to the policy and rules
... source[x] Σ0..1The evidence used to support the patient will.
.... sourceAttachmentAttachment
.... sourceReferenceReference(Consent | DocumentReference | Contract | QuestionnaireResponse)
... policyRule ΣI1..1CodeableConceptRegulation that this consents to
Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples.

.... text Σ0..1stringPlain text representation of the concept
Fixed Value: Belgian policy
... provision Σ1..1BackboneElementConstraints to the base Consent.policyRule
.... type Σ0..1codedeny | permit
Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent.

.... period Σ1..1PeriodTimeframe for this rule
.... code Σ0..*CodeableConceptThe actual directive in the will
Binding: Patient Will code Value Set (required)

doco Documentation for this format

Differential View

This structure is derived from Consent

NameFlagsCard.TypeDescription & Constraintsdoco
.. Consent 0..*ConsentA healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
... identifier S0..*IdentifierIdentifier for this record (external references)
... status S1..1codedraft | proposed | active | rejected | inactive | entered-in-error
... scope S1..1CodeableConceptWhich of the four areas this resource covers (extensible)
... patient S1..1Reference(BePatient)The subject of the patient will.
... dateTime S1..1dateTimeThe dateTime when the patient will has been recorded
... performer S1..*Reference(BeOrganization | BePatient | BePractitioner | BePractitionerRole | RelatedPerson)Who is agreeing to the policy and rules
... source[x] S0..1Attachment, Reference(Consent | DocumentReference | Contract | QuestionnaireResponse)The evidence used to support the patient will.
... policyRule S1..1CodeableConceptRegulation that this consents to
.... text S0..1stringPlain text representation of the concept
Fixed Value: Belgian policy
... provision S1..1BackboneElementConstraints to the base Consent.policyRule
.... type S0..1codedeny | permit
.... period S1..1PeriodTimeframe for this rule
.... securityLabel 0..0
.... purpose 0..0
.... class 0..0
.... code S0..*CodeableConceptThe actual directive in the will
Binding: Patient Will code Value Set (required)
.... data 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Consent I0..*ConsentA healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierIdentifier for this record (external references)

Example General: {"system":"urn:ietf:rfc:3986","value":"Local eCMS identifier"}
... status ?!SΣ1..1codedraft | proposed | active | rejected | inactive | entered-in-error
Binding: ConsentState (required): Indicates the state of the consent.

... scope ?!SΣ1..1CodeableConceptWhich of the four areas this resource covers (extensible)
Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource.

... category SΣ1..*CodeableConceptClassification of the consent statement - for indexing/retrieval
Binding: Patient Will Category (required)
... patient SΣ1..1Reference(BePatient)The subject of the patient will.
... dateTime SΣ1..1dateTimeThe dateTime when the patient will has been recorded
... performer SΣ1..*Reference(BeOrganization | BePatient | BePractitioner | BePractitionerRole | RelatedPerson)Who is agreeing to the policy and rules
... organization Σ0..*Reference(Organization)Custodian of the consent
... source[x] SΣ0..1The evidence used to support the patient will.
.... sourceAttachmentAttachment
.... sourceReferenceReference(Consent | DocumentReference | Contract | QuestionnaireResponse)
... policy 0..*BackboneElementPolicies covered by this consent
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... authority I0..1uriEnforcement source for policy
.... uri I0..1uriSpecific policy covered by this consent
... policyRule SΣI1..1CodeableConceptRegulation that this consents to
Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples.

.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*CodingCode defined by a terminology system
.... text SΣ0..1stringPlain text representation of the concept
Fixed Value: Belgian policy
... verification Σ0..*BackboneElementConsent Verified by patient or family
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... verified Σ1..1booleanHas been verified
.... verifiedWith 0..1Reference(Patient | RelatedPerson)Person who verified
.... verificationDate 0..1dateTimeWhen consent verified
... provision SΣ1..1BackboneElementConstraints to the base Consent.policyRule
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type SΣ0..1codedeny | permit
Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent.

.... period SΣ1..1PeriodTimeframe for this rule
.... actor 0..*BackboneElementWho|what controlled by this rule (or group, by role)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... role 1..1CodeableConceptHow the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.

..... reference 1..1Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole)Resource for the actor (or group, by role)
.... action Σ0..*CodeableConceptActions controlled by this rule
Binding: ConsentActionCodes (example): Detailed codes for the consent action.


.... code SΣ0..*CodeableConceptThe actual directive in the will
Binding: Patient Will code Value Set (required)
.... dataPeriod Σ0..1PeriodTimeframe for data controlled by this rule
.... provision 0..*See provision (Consent)Nested Exception Rules

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Consent.languagepreferredCommonLanguages
Max Binding: AllLanguages
Consent.statusrequiredConsentState
Consent.scopeextensibleConsentScopeCodes
Consent.categoryrequiredBeVSPatientWillCategory
Consent.policyRuleextensibleConsentPolicyRuleCodes
Consent.provision.typerequiredConsentProvisionType
Consent.provision.actor.roleextensibleSecurityRoleType
Consent.provision.actionexampleConsentActionCodes
Consent.provision.coderequiredBeVSPatientWillCode
Consent.provision.data.meaningrequiredConsentDataMeaning

Constraints

IdPathDetailsRequirements
dom-2ConsentIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3ConsentIf 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-4ConsentIf 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-5ConsentIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6ConsentA resource should have narrative for robust management
: text.`div`.exists()
ppc-1ConsentEither a Policy or PolicyRule
: policy.exists() or policyRule.exists()
ppc-2ConsentIF Scope=privacy, there must be a patient
: patient.exists() or scope.coding.where(system='something' and code='patient-privacy').exists().not()
ppc-3ConsentIF Scope=research, there must be a patient
: patient.exists() or scope.coding.where(system='something' and code='research').exists().not()
ppc-4ConsentIF Scope=adr, there must be a patient
: patient.exists() or scope.coding.where(system='something' and code='adr').exists().not()
ppc-5ConsentIF Scope=treatment, there must be a patient
: patient.exists() or scope.coding.where(system='something' and code='treatment').exists().not()
ele-1Consent.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Consent.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Consent.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Consent.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Consent.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.scopeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.categoryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.patientAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.dateTimeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.performerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.organizationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.source[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.policyAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.policy.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Consent.policy.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Consent.policy.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Consent.policy.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Consent.policy.authorityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.policy.uriAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.policyRuleAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.policyRule.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Consent.policyRule.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Consent.policyRule.codingAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.policyRule.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.verificationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.verification.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Consent.verification.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Consent.verification.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Consent.verification.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Consent.verification.verifiedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.verification.verifiedWithAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.verification.verificationDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.provisionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.provision.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Consent.provision.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Consent.provision.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Consent.provision.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Consent.provision.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.provision.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.provision.actorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.provision.actor.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Consent.provision.actor.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Consent.provision.actor.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Consent.provision.actor.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Consent.provision.actor.roleAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.provision.actor.referenceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.provision.actionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.provision.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.provision.dataPeriodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.provision.data.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Consent.provision.data.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Consent.provision.data.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Consent.provision.data.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Consent.provision.data.meaningAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.provision.data.referenceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.provision.provisionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())