HL7 Belgium Patientwill (Patient Dossier)
1.0.0 - STU Belgium flag

This page is part of the eHealth FHIR Patient Will Profiles for Belgium (v1.0.0: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: BePatientWill

Official URL: https://www.ehealth.fgov.be/standards/fhir/patientwill/StructureDefinition/be-patientwill Version: 1.0.0
Active as of 2021-01-10 Computable Name: 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.

Usage:

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
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... note S0..1AnnotationBeExtSimpleNote
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-simple-note
... recorder S1..1Reference(BePatient | BePractitioner | BeOrganization)BeExtRecorder
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-recorder
... status S1..1codeThis is the status of the patient will expressed under provision.code .
... scope 1..1CodeableConceptScope is not explicit in the Belgian context
Binding: BeVSPatientWillScope (extensible)
... category S1..*CodeableConceptClassification of the consent statement - for indexing/retrieval
Binding: Patient Will Category (required)
... patient S1..1Reference(BePatient)The subject of the patient will.
... dateTime S1..1dateTimeThe dateTime when the patient will has been recorded
... performer S0..*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] S0..1Attachment, Reference(Consent | DocumentReference | Contract | QuestionnaireResponse)The evidence used to support the patient will.
Slice: Unordered, Open by type:$this
.... source[x]:sourceReference 0..1Reference(DocumentReference)Source from which this consent is taken
... policyRule 0..1CodeableConceptProvide a short textual description in the .text attribute (see invariant ppc-1)
... provision S1..1BackboneElementConstraints to the base Consent.policyRule
.... period S1..1PeriodTimeframe for this rule
.... securityLabel 0..0
.... purpose 0..0
.... class 0..0
.... code S1..1CodeableConceptThe actual directive in the will
Binding: Patient Will code Value Set (required)
.... data 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Consent.scopeextensibleBeVSPatientWillScope
Consent.categoryrequiredBeVSPatientWillCategory (a valid code from Patient Will Category CodeSystem)
Consent.provision.coderequiredBeVSPatientWillCode (a valid code from Patient Will Directive CodeSystem)
NameFlagsCard.TypeDescription & Constraintsdoco
.. Consent C0..*ConsentA healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... note S0..1AnnotationBeExtSimpleNote
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-simple-note
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierIdentifier for this record (external references)

Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"}
... status ?!SΣ1..1codeThis is the status of the patient will expressed under provision.code .
Binding: ConsentState (required): Indicates the state of the consent.

... scope ?!Σ1..1CodeableConceptScope is not explicit in the Belgian context
Binding: BeVSPatientWillScope (extensible)
... 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Σ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..1The evidence used to support the patient will.
Slice: Unordered, Open by type:$this
.... sourceAttachmentAttachment
.... sourceReferenceReference(Consent | DocumentReference | Contract | QuestionnaireResponse)
.... source[x]:sourceReference Σ0..1Reference(DocumentReference)Source from which this consent is taken
... policyRule ΣC0..1CodeableConceptProvide a short textual description in the .text attribute (see invariant ppc-1)
Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples.

... provision SΣ1..1BackboneElementConstraints to the base Consent.policyRule
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... period SΣ1..1PeriodTimeframe for this rule
.... code SΣ1..1CodeableConceptThe actual directive in the will
Binding: Patient Will code Value Set (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Consent.statusrequiredConsentState
Consent.scopeextensibleBeVSPatientWillScope
Consent.categoryrequiredBeVSPatientWillCategory (a valid code from Patient Will Category CodeSystem)
Consent.policyRuleextensibleConsentPolicyRuleCodes
Consent.provision.coderequiredBeVSPatientWillCode (a valid code from Patient Will Directive CodeSystem)
Consent.provision.data.meaningrequiredConsentDataMeaning
NameFlagsCard.TypeDescription & Constraintsdoco
.. Consent C0..*ConsentA healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
... id Σ0..1idLogical 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
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... note S0..1AnnotationBeExtSimpleNote
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-simple-note
... recorder S1..1Reference(BePatient | BePractitioner | BeOrganization)BeExtRecorder
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-recorder
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierIdentifier for this record (external references)

Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"}
... status ?!SΣ1..1codeThis is the status of the patient will expressed under provision.code .
Binding: ConsentState (required): Indicates the state of the consent.

... scope ?!Σ1..1CodeableConceptScope is not explicit in the Belgian context
Binding: BeVSPatientWillScope (extensible)
... 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Σ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..1The evidence used to support the patient will.
Slice: Unordered, Open by type:$this
.... sourceAttachmentAttachment
.... sourceReferenceReference(Consent | DocumentReference | Contract | QuestionnaireResponse)
.... source[x]:sourceReference Σ0..1Reference(DocumentReference)Source from which this consent is taken
... 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 C0..1uriEnforcement source for policy
.... uri C0..1uriSpecific policy covered by this consent
... policyRule ΣC0..1CodeableConceptProvide a short textual description in the .text attribute (see invariant ppc-1)
Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples.

... 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 Σ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Σ1..1CodeableConceptThe 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

Terminology Bindings

PathConformanceValueSet
Consent.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Consent.statusrequiredConsentState
Consent.scopeextensibleBeVSPatientWillScope
Consent.categoryrequiredBeVSPatientWillCategory (a valid code from Patient Will Category CodeSystem)
Consent.policyRuleextensibleConsentPolicyRuleCodes
Consent.provision.typerequiredConsentProvisionType
Consent.provision.actor.roleextensibleSecurityRoleType
Consent.provision.actionexampleConsentActionCodes
Consent.provision.coderequiredBeVSPatientWillCode (a valid code from Patient Will Directive CodeSystem)
Consent.provision.data.meaningrequiredConsentDataMeaning

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
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... note S0..1AnnotationBeExtSimpleNote
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-simple-note
... recorder S1..1Reference(BePatient | BePractitioner | BeOrganization)BeExtRecorder
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-recorder
... status S1..1codeThis is the status of the patient will expressed under provision.code .
... scope 1..1CodeableConceptScope is not explicit in the Belgian context
Binding: BeVSPatientWillScope (extensible)
... category S1..*CodeableConceptClassification of the consent statement - for indexing/retrieval
Binding: Patient Will Category (required)
... patient S1..1Reference(BePatient)The subject of the patient will.
... dateTime S1..1dateTimeThe dateTime when the patient will has been recorded
... performer S0..*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] S0..1Attachment, Reference(Consent | DocumentReference | Contract | QuestionnaireResponse)The evidence used to support the patient will.
Slice: Unordered, Open by type:$this
.... source[x]:sourceReference 0..1Reference(DocumentReference)Source from which this consent is taken
... policyRule 0..1CodeableConceptProvide a short textual description in the .text attribute (see invariant ppc-1)
... provision S1..1BackboneElementConstraints to the base Consent.policyRule
.... period S1..1PeriodTimeframe for this rule
.... securityLabel 0..0
.... purpose 0..0
.... class 0..0
.... code S1..1CodeableConceptThe actual directive in the will
Binding: Patient Will code Value Set (required)
.... data 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Consent.scopeextensibleBeVSPatientWillScope
Consent.categoryrequiredBeVSPatientWillCategory (a valid code from Patient Will Category CodeSystem)
Consent.provision.coderequiredBeVSPatientWillCode (a valid code from Patient Will Directive CodeSystem)

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Consent C0..*ConsentA healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... note S0..1AnnotationBeExtSimpleNote
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-simple-note
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierIdentifier for this record (external references)

Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"}
... status ?!SΣ1..1codeThis is the status of the patient will expressed under provision.code .
Binding: ConsentState (required): Indicates the state of the consent.

... scope ?!Σ1..1CodeableConceptScope is not explicit in the Belgian context
Binding: BeVSPatientWillScope (extensible)
... 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Σ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..1The evidence used to support the patient will.
Slice: Unordered, Open by type:$this
.... sourceAttachmentAttachment
.... sourceReferenceReference(Consent | DocumentReference | Contract | QuestionnaireResponse)
.... source[x]:sourceReference Σ0..1Reference(DocumentReference)Source from which this consent is taken
... policyRule ΣC0..1CodeableConceptProvide a short textual description in the .text attribute (see invariant ppc-1)
Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples.

... provision SΣ1..1BackboneElementConstraints to the base Consent.policyRule
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... period SΣ1..1PeriodTimeframe for this rule
.... code SΣ1..1CodeableConceptThe actual directive in the will
Binding: Patient Will code Value Set (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Consent.statusrequiredConsentState
Consent.scopeextensibleBeVSPatientWillScope
Consent.categoryrequiredBeVSPatientWillCategory (a valid code from Patient Will Category CodeSystem)
Consent.policyRuleextensibleConsentPolicyRuleCodes
Consent.provision.coderequiredBeVSPatientWillCode (a valid code from Patient Will Directive CodeSystem)
Consent.provision.data.meaningrequiredConsentDataMeaning

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Consent C0..*ConsentA healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
... id Σ0..1idLogical 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
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... note S0..1AnnotationBeExtSimpleNote
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-simple-note
... recorder S1..1Reference(BePatient | BePractitioner | BeOrganization)BeExtRecorder
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-recorder
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierIdentifier for this record (external references)

Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"}
... status ?!SΣ1..1codeThis is the status of the patient will expressed under provision.code .
Binding: ConsentState (required): Indicates the state of the consent.

... scope ?!Σ1..1CodeableConceptScope is not explicit in the Belgian context
Binding: BeVSPatientWillScope (extensible)
... 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Σ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..1The evidence used to support the patient will.
Slice: Unordered, Open by type:$this
.... sourceAttachmentAttachment
.... sourceReferenceReference(Consent | DocumentReference | Contract | QuestionnaireResponse)
.... source[x]:sourceReference Σ0..1Reference(DocumentReference)Source from which this consent is taken
... 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 C0..1uriEnforcement source for policy
.... uri C0..1uriSpecific policy covered by this consent
... policyRule ΣC0..1CodeableConceptProvide a short textual description in the .text attribute (see invariant ppc-1)
Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples.

... 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 Σ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Σ1..1CodeableConceptThe 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

Terminology Bindings

PathConformanceValueSet
Consent.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Consent.statusrequiredConsentState
Consent.scopeextensibleBeVSPatientWillScope
Consent.categoryrequiredBeVSPatientWillCategory (a valid code from Patient Will Category CodeSystem)
Consent.policyRuleextensibleConsentPolicyRuleCodes
Consent.provision.typerequiredConsentProvisionType
Consent.provision.actor.roleextensibleSecurityRoleType
Consent.provision.actionexampleConsentActionCodes
Consent.provision.coderequiredBeVSPatientWillCode (a valid code from Patient Will Directive CodeSystem)
Consent.provision.data.meaningrequiredConsentDataMeaning

 

Other representations of profile: CSV, Excel, Schematron