HL7 Belgium FHIR specifications
0.1 - QA review

This page is part of the HL7 Belgium FHIR Specifications (v2020May: QA Preview) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions

StructureDefinition: BePatientWill

****!DRAFT!DRAFT!DRAFT! VALUESETS STILL TO BE DELIVERED FOR THIS PROFILE BY THE NIHDI **** 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.

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

Summary

Mandatory: 4 elements (1 nested mandatory element)
Must-Support: 12 elements
Fixed Value: 1 element
Prohibited: 4 elements

Structures

This structure refers to these other structures:

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..1CodeableConceptThe actual directive in the will
... 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 | RelatedPerson | https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-practitionerRole)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
.... type S0..1codedeny | permit
.... period S1..1PeriodThe period of validity for the patient will directive
.... securityLabel 0..0
.... purpose 0..0
.... class 0..0
.... 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 ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier SΣI0..*IdentifierIdentifier for this record (external references)

Example General: {"system":"urn:ietf:rfc:3986","value":"Local eCMS identifier"}
... status ?!SΣI1..1codedraft | proposed | active | rejected | inactive | entered-in-error
Binding: ConsentState (required)
... scope ?!SΣI1..1CodeableConceptThe actual directive in the will
Binding: ConsentScopeCodes (extensible)
... category SΣI1..1CodeableConceptThe category or the patient will directive
Binding: ConsentCategoryCodes (extensible)
... patient SΣI1..1Reference(BePatient)The subject of the patient will.
... dateTime SΣI1..1dateTimeThe dateTime when the patient will has been recorded
... performer SΣI1..*Reference(BeOrganization | BePatient | BePractitioner | RelatedPerson | https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-practitionerRole)Who is agreeing to the policy and rules
... organization ΣI0..*Reference(Organization)Custodian of the consent
... source[x] SΣI0..1The evidence used to support the patient will.
.... sourceAttachmentAttachment
.... sourceReferenceReference(Consent | DocumentReference | Contract | QuestionnaireResponse)
... policy I0..*BackboneElementPolicies covered by this consent
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*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)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding ΣI0..*CodingCode defined by a terminology system
.... text SΣI0..1stringPlain text representation of the concept
Fixed Value: Belgian policy
... verification ΣI0..*BackboneElementConsent Verified by patient or family
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... verified ΣI1..1booleanHas been verified
.... verifiedWith I0..1Reference(Patient | RelatedPerson)Person who verified
.... verificationDate I0..1dateTimeWhen consent verified
... provision ΣI0..1BackboneElementConstraints to the base Consent.policyRule
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type SΣI0..1codedeny | permit
Binding: ConsentProvisionType (required)
.... period SΣI1..1PeriodThe period of validity for the patient will directive
.... actor I0..*BackboneElementWho|what controlled by this rule (or group, by role)
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... role I1..1CodeableConceptHow the actor is involved
Binding: SecurityRoleType (extensible)
..... reference I1..1Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole)Resource for the actor (or group, by role)
.... action ΣI0..*CodeableConceptActions controlled by this rule
Binding: ConsentActionCodes (example)
.... code ΣI0..*CodeableConcepte.g. LOINC or SNOMED CT code, etc. in the content
Binding: ConsentContentCodes (example)
.... dataPeriod ΣI0..1PeriodTimeframe for data controlled by this rule
.... provision I0..*Unknown reference to #Consent.provision
Nested Exception Rules

doco Documentation for this format

This structure is derived from Consent

Summary

Mandatory: 4 elements (1 nested mandatory element)
Must-Support: 12 elements
Fixed Value: 1 element
Prohibited: 4 elements

Structures

This structure refers to these other structures:

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..1CodeableConceptThe actual directive in the will
... 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 | RelatedPerson | https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-practitionerRole)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
.... type S0..1codedeny | permit
.... period S1..1PeriodThe period of validity for the patient will directive
.... securityLabel 0..0
.... purpose 0..0
.... class 0..0
.... 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 ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier SΣI0..*IdentifierIdentifier for this record (external references)

Example General: {"system":"urn:ietf:rfc:3986","value":"Local eCMS identifier"}
... status ?!SΣI1..1codedraft | proposed | active | rejected | inactive | entered-in-error
Binding: ConsentState (required)
... scope ?!SΣI1..1CodeableConceptThe actual directive in the will
Binding: ConsentScopeCodes (extensible)
... category SΣI1..1CodeableConceptThe category or the patient will directive
Binding: ConsentCategoryCodes (extensible)
... patient SΣI1..1Reference(BePatient)The subject of the patient will.
... dateTime SΣI1..1dateTimeThe dateTime when the patient will has been recorded
... performer SΣI1..*Reference(BeOrganization | BePatient | BePractitioner | RelatedPerson | https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-practitionerRole)Who is agreeing to the policy and rules
... organization ΣI0..*Reference(Organization)Custodian of the consent
... source[x] SΣI0..1The evidence used to support the patient will.
.... sourceAttachmentAttachment
.... sourceReferenceReference(Consent | DocumentReference | Contract | QuestionnaireResponse)
... policy I0..*BackboneElementPolicies covered by this consent
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*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)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding ΣI0..*CodingCode defined by a terminology system
.... text SΣI0..1stringPlain text representation of the concept
Fixed Value: Belgian policy
... verification ΣI0..*BackboneElementConsent Verified by patient or family
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... verified ΣI1..1booleanHas been verified
.... verifiedWith I0..1Reference(Patient | RelatedPerson)Person who verified
.... verificationDate I0..1dateTimeWhen consent verified
... provision ΣI0..1BackboneElementConstraints to the base Consent.policyRule
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type SΣI0..1codedeny | permit
Binding: ConsentProvisionType (required)
.... period SΣI1..1PeriodThe period of validity for the patient will directive
.... actor I0..*BackboneElementWho|what controlled by this rule (or group, by role)
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... role I1..1CodeableConceptHow the actor is involved
Binding: SecurityRoleType (extensible)
..... reference I1..1Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole)Resource for the actor (or group, by role)
.... action ΣI0..*CodeableConceptActions controlled by this rule
Binding: ConsentActionCodes (example)
.... code ΣI0..*CodeableConcepte.g. LOINC or SNOMED CT code, etc. in the content
Binding: ConsentContentCodes (example)
.... dataPeriod ΣI0..1PeriodTimeframe for data controlled by this rule
.... provision I0..*Unknown reference to #Consent.provision
Nested Exception Rules

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

Terminology Bindings

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

Constraints

Constraints

IdPathDetailsRequirements