HdBe-AdvanceDirective
Profile | Description | Status | URL |
---|---|---|---|
HdBe-AdvanceDirective | An AdvanceDirective is a verbal or written description of the patient’s wishes with regard to future medical action or end of their life. An advanceDirective is mainly used for situations in which the patient is no longer able to speak about these decisions with their healthcare provider. | draft | https://fhir.healthdata.be/StructureDefinition/HdBe-AdvanceDirective |
Consent | I | Consent | Element IdConsent AdvanceDirective Alternate namesWilsverklaring DefinitionA record of a healthcare consumer’s choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time. Broadly, there are 3 key areas of consent for patients: Consent around sharing information (aka Privacy Consent Directive - Authorization to Collect, Use, or Disclose information), consent for specific treatment, or kinds of treatment, and general advance care directives.
| |
extension | I | 0..* | Extension | Element IdConsent.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Constraints
|
disorder | I | 0..* | Extension(Reference(HdBe Problem)) | Element IdConsent.extension:disorder Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Extension(Reference(HdBe Problem)) Extension URLhttps://fhir.healthdata.be/StructureDefinition/ext-AdvanceDirective.Disorder Constraints
|
comment | I | 0..1 | Extension(string) | Element IdConsent.extension:comment Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. https://fhir.healthdata.be/StructureDefinition/ext-Comment Constraints
|
url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdConsent.extension:comment.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. System.String Fixed Valuehttps://fhir.healthdata.be/StructureDefinition/ext-Comment
| |
value[x] | 0..1 | Element IdConsent.extension:comment.value[x] Comment Alternate namesToelichting DefinitionComment on the living will: the form, such as a medallion, tattoo, etc., or where the living will can be found.
| ||
valueString | string | There are no (further) constraints on this element Data Type | ||
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element IdConsent.identifier Identifier for this record (external references) DefinitionUnique identifier for this copy of the Consent Statement. This identifier identifies this copy of the consent. Where this identifier is also used elsewhere as the identifier for a consent record (e.g. a CDA consent document) then the consent details are expected to be the same.
General { "system": "urn:ietf:rfc:3986", "value": "Local eCMS identifier" } Mappings
|
status | Σ ?! | 1..1 | codeBinding | Element IdConsent.status draft | proposed | active | rejected | inactive | entered-in-error DefinitionIndicates the current state of this consent. The Consent Directive that is pointed to might be in various lifecycle states, e.g., a revoked Consent Directive. This element has no functional counterpart in the CBB and cannot be implicitly mapped to other concepts. Unless a more appropriate status is recorded, it is assumed that only active Consent resources will be exchanged. Indicates the state of the consent. ConsentState (required)Constraints
|
scope | Σ ?! | 1..1 | CodeableConceptBinding | Element IdConsent.scope Which of the four areas this resource covers (extensible) DefinitionA selector of the type of consent being presented: ADR, Privacy, Treatment, Research. This list is now extensible. At the moment of writing (02-11-2021) the adr code is incorrectly removed from the ConsentScopeCodes CodeSystem (http://terminology.hl7.org/CodeSystem/consentscope). This will be corrected within the R4 release of FHIR based on this tracker item: https://jira.hl7.org/browse/FHIR-34215. The four anticipated uses for the Consent Resource. ConsentScopeCodes (extensible)Constraints
{ "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/consentscope", "code": "adr" } ] }
|
category | Σ | 1..* | CodeableConceptBinding | Element IdConsent.category Classification of the consent statement - for indexing/retrieval DefinitionA classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. A classification of the type of consents found in a consent statement. ConsentCategoryCodes (extensible)Constraints
{ "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/consentcategorycodes", "code": "acd" } ] }
|
patient | Σ I | 0..1 | Reference(Patient) | There are no (further) constraints on this element Element IdConsent.patient Who the consent applies to DefinitionThe patient/healthcare consumer to whom this consent applies. Commonly, the patient the consent pertains to is the author, but for young and old people, it may be some other person.
|
dateTime | Σ | 0..1 | dateTime | Element IdConsent.dateTime LivingWillDate Alternate namesWilsverklaringDatum DefinitionThe date on which the living will was recorded. This is not the time of the original consent, but the time that this statement was made or derived.
|
performer | Σ I | 0..* | Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | There are no (further) constraints on this element Element IdConsent.performer Who is agreeing to the policy and rules Alternate namesconsentor DefinitionEither the Grantor, which is the entity responsible for granting the rights listed in a Consent Directive or the Grantee, which is the entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations and enforcement of prohibitions. Commonly, the patient the consent pertains to is the consentor, but particularly for young and old people, it may be some other person - e.g. a legal guardian. Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) Constraints
|
organization | Σ I | 0..* | Reference(Organization) | There are no (further) constraints on this element Element IdConsent.organization Custodian of the consent Alternate namescustodian DefinitionThe organization that manages the consent, and the framework within which it is executed. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
source[x] | Σ | 0..1 | Element IdConsent.source[x] Source from which this consent is taken DefinitionThe source on which this consent statement is based. The source might be a scanned original paper form, or a reference to a consent that links back to such a source, a reference to a document repository (e.g. XDS) that stores the original consent document. The source can be contained inline (Attachment), referenced directly (Consent), referenced in a consent repository (DocumentReference), or simply by an identifier (Identifier), e.g. a CDA document id. Unordered, Open, by $this(Type) Constraints
| |
sourceReference | Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) | There are no (further) constraints on this element Data Type Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) | ||
sourceAttachment | Σ | 0..1 | Attachment | Element IdConsent.source[x]:sourceAttachment Source from which this consent is taken DefinitionThe source on which this consent statement is based. The source might be a scanned original paper form, or a reference to a consent that links back to such a source, a reference to a document repository (e.g. XDS) that stores the original consent document. The source can be contained inline (Attachment), referenced directly (Consent), referenced in a consent repository (DocumentReference), or simply by an identifier (Identifier), e.g. a CDA document id.
|
contentType | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element IdConsent.source[x]:sourceAttachment.contentType Mime type of the content, with charset etc. DefinitionIdentifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate. Processors of the data need to be able to know how to interpret the data. Note that FHIR strings SHALL NOT exceed 1MB in size The mime type of an attachment. Any valid mime type is allowed. Mime Types (required)Constraints
General text/plain; charset=UTF-8, image/png Mappings
|
language | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element IdConsent.source[x]:sourceAttachment.language Human language of the content (BCP-47) DefinitionThe human language of the content. The value can be any valid value according to BCP 47. Users need to be able to choose between the languages in a set of attachments. Note that FHIR strings SHALL NOT exceed 1MB in size A human language. CommonLanguages (preferred)Constraints
General en-AU Mappings
|
data | 0..1 | base64Binary | Element IdConsent.source[x]:sourceAttachment.data LivingWillDocument Alternate namesWilsverklaringDocument DefinitionScanned source document with the living will and the patient's signature, such as a PDF. The data needs to able to be transmitted inline. The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON.
| |
url | Σ | 0..1 | url | There are no (further) constraints on this element Element IdConsent.source[x]:sourceAttachment.url Uri where the data can be found DefinitionA location where the data can be accessed. The data needs to be transmitted by reference. If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data.
General http://www.acme.com/logo-small.png Mappings
|
size | Σ | 0..1 | unsignedInt | There are no (further) constraints on this element Element IdConsent.source[x]:sourceAttachment.size Number of bytes of content (if url provided) DefinitionThe number of bytes of data that make up this attachment (before base64 encoding, if that is done). Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all. The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference.
|
hash | Σ | 0..1 | base64Binary | There are no (further) constraints on this element Element IdConsent.source[x]:sourceAttachment.hash Hash of the data (sha-1, base64ed) DefinitionThe calculated hash of the data using SHA-1. Represented using base64. Included so that applications can verify that the contents of a location have not changed due to technical failures (e.g., storage rot, transport glitch, incorrect version). The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. The hash is not intended to support digital signatures. Where protection against malicious threats a digital signature should be considered, see Provenance.signature for mechanism to protect a resource with a digital signature.
|
title | Σ | 0..1 | string | There are no (further) constraints on this element Element IdConsent.source[x]:sourceAttachment.title Label to display in place of the data DefinitionA label or set of text to display in place of the data. Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer. Note that FHIR strings SHALL NOT exceed 1MB in size
General Official Corporate Logo Mappings
|
creation | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element IdConsent.source[x]:sourceAttachment.creation Date attachment was first created DefinitionThe date that the attachment was first created. This is often tracked as an integrity issue for use of the attachment.
|
policy | 0..* | BackboneElement | There are no (further) constraints on this element Element IdConsent.policy Policies covered by this consent DefinitionThe references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law.
| |
authority | I | 0..1 | uri | There are no (further) constraints on this element Element IdConsent.policy.authority Enforcement source for policy DefinitionEntity or Organization having regulatory jurisdiction or accountability for enforcing policies pertaining to Consent Directives. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
|
uri | I | 0..1 | uri | Element IdConsent.policy.uri Specific policy covered by this consent DefinitionThe references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law. Either
|
policyRule | Σ I | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdConsent.policyRule Regulation that this consents to DefinitionA reference to the specific base computable regulation or policy. Might be a unique identifier of a policy set in XACML, or other rules engine. If the policyRule is absent, computable consent would need to be constructed from the elements of the Consent resource. Regulatory policy examples. ConsentPolicyRuleCodes (extensible)Constraints
|
verification | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element IdConsent.verification Consent Verified by patient or family DefinitionWhether a treatment instruction (e.g. artificial respiration yes or no) was verified with the patient, his/her family or another authorized person.
|
verified | Σ | 1..1 | boolean | There are no (further) constraints on this element Element IdConsent.verification.verified Has been verified DefinitionHas the instruction been verified.
|
verifiedWith | I | 0..1 | Reference(Patient | RelatedPerson) | There are no (further) constraints on this element Element IdConsent.verification.verifiedWith Person who verified DefinitionWho verified the instruction (Patient, Relative or other Authorized Person). References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Patient | RelatedPerson) Constraints
|
verificationDate | 0..1 | dateTime | There are no (further) constraints on this element Element IdConsent.verification.verificationDate When consent verified DefinitionDate verification was collected.
| |
provision | Σ | 0..1 | BackboneElement | There are no (further) constraints on this element Element IdConsent.provision Constraints to the base Consent.policyRule DefinitionAn exception to the base policy of this consent. An exception can be an addition or removal of access permissions.
|
type | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element IdConsent.provision.type deny | permit DefinitionAction to take - permit or deny - when the rule conditions are met. Not permitted in root rule, required in all nested rules. Note that FHIR strings SHALL NOT exceed 1MB in size How a rule statement is applied, such as adding additional consent or removing consent. ConsentProvisionType (required)Constraints
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdConsent.provision.period Timeframe for this rule DefinitionThe timeframe in this rule is valid. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
actor | 0..* | BackboneElement | Element IdConsent.provision.actor Who|what controlled by this rule (or group, by role) DefinitionWho or what is controlled by this rule. Use group to identify a set of actors by some property they share (e.g. 'admitting officers'). Unordered, Open, by role(Value) Constraints
| |
(All Slices) | There are no (further) constraints on this element | |||
role | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdConsent.provision.actor.role How the actor is involved DefinitionHow the individual is involved in the resources content that is described in the exception. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. How an actor is involved in the consent considerations. SecurityRoleType (extensible)Constraints
| |
reference | I | 1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | There are no (further) constraints on this element Element IdConsent.provision.actor.reference Resource for the actor (or group, by role) DefinitionThe resource that identifies the actor. To identify actors by type, use group to identify a set of actors by some property they share (e.g. 'admitting officers'). References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) Constraints
|
representative | 0..* | BackboneElement | There are no (further) constraints on this element Element IdConsent.provision.actor:representative Who|what controlled by this rule (or group, by role) DefinitionWho or what is controlled by this rule. Use group to identify a set of actors by some property they share (e.g. 'admitting officers').
| |
role | 1..1 | CodeableConceptBinding | Element IdConsent.provision.actor:representative.role How the actor is involved DefinitionHow the individual is involved in the resources content that is described in the exception. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. How an actor is involved in the consent considerations. SecurityRoleType (extensible)Constraints
{ "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode", "code": "RESPRSN" } ] }
| |
reference | I | 1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole | HdBe ContactPerson) | Element IdConsent.provision.actor:representative.reference Representative Alternate namesVertegenwoordiger DefinitionThe person who is the legal representative or is appointed as the authorized representative in the signed authorization. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole | HdBe ContactPerson) Constraints
|
action | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element IdConsent.provision.action Actions controlled by this rule DefinitionActions controlled by this Rule. Note that this is the direct action (not the grounds for the action covered in the purpose element). At present, the only action in the understood and tested scope of this resource is 'read'. Detailed codes for the consent action. ConsentActionCodes (example)Constraints
|
securityLabel | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element IdConsent.provision.securityLabel Security Labels that define affected resources DefinitionA security label, comprised of 0..* security label fields (Privacy tags), which define which resources are controlled by this exception. If the consent specifies a security label of "R" then it applies to all resources that are labeled "R" or lower. E.g. for Confidentiality, it's a high water mark. For other kinds of security labels, subsumption logic applies. When the purpose of use tag is on the data, access request purpose of use shall not conflict. Security Labels from the Healthcare Privacy and Security Classification System. All Security Labels (extensible)Constraints
|
purpose | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element IdConsent.provision.purpose Context of activities covered by this rule DefinitionThe context of the activities a user is taking - why the user is accessing the data - that are controlled by this rule. When the purpose of use tag is on the data, access request purpose of use shall not conflict. What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels. v3.PurposeOfUse (extensible)Constraints
|
class | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element IdConsent.provision.class e.g. Resource Type, Profile, CDA, etc. DefinitionThe class of information covered by this rule. The type can be a FHIR resource type, a profile on a type, or a CDA document, or some other type that indicates what sort of information the consent relates to. Multiple types are or'ed together. The intention of the contentType element is that the codes refer to profiles or document types defined in a standard or an implementation guide somewhere. The class (type) of information a consent rule covers. ConsentContentClass (extensible)Constraints
|
code | Σ | 0..1 | CodeableConceptBinding | Element IdConsent.provision.code LivingWillType Alternate namesWilsverklaringType DefinitionThe type of living will. Typical use of this is a Document code with class = CDA. If this code is found in an instance, then the exception applies. TypeOfLivingWill (extensible)Constraints
|
dataPeriod | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdConsent.provision.dataPeriod Timeframe for data controlled by this rule DefinitionClinical or Operational Relevant period of time that bounds the data controlled by this rule. This has a different sense to the Consent.period - that is when the consent agreement holds. This is the time period of the data that is controlled by the agreement.
|
data | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element IdConsent.provision.data Data controlled by this rule DefinitionThe resources controlled by this rule if specific resources are referenced.
|
meaning | Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element IdConsent.provision.data.meaning instance | related | dependents | authoredby DefinitionHow the resource reference is interpreted when testing consent restrictions. Note that FHIR strings SHALL NOT exceed 1MB in size How a resource reference is interpreted when testing consent restrictions. ConsentDataMeaning (required)Constraints
|
reference | Σ I | 1..1 | Reference(Resource) | There are no (further) constraints on this element Element IdConsent.provision.data.reference The actual data reference DefinitionA reference to a specific resource that defines which resources are covered by this consent. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
provision | 0..* | see (provision) | There are no (further) constraints on this element Element IdConsent.provision.provision Nested Exception Rules DefinitionRules which provide exceptions to the base rule or subrules. |
Consent | I | Consent | Element IdConsent AdvanceDirective Alternate namesWilsverklaring DefinitionA record of a healthcare consumer’s choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time. Broadly, there are 3 key areas of consent for patients: Consent around sharing information (aka Privacy Consent Directive - Authorization to Collect, Use, or Disclose information), consent for specific treatment, or kinds of treatment, and general advance care directives.
| |
extension | I | 0..* | Extension | Element IdConsent.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Constraints
|
disorder | I | 0..* | Extension(Reference(HdBe Problem)) | Element IdConsent.extension:disorder Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Extension(Reference(HdBe Problem)) Extension URLhttps://fhir.healthdata.be/StructureDefinition/ext-AdvanceDirective.Disorder Constraints
|
comment | I | 0..1 | Extension(string) | Element IdConsent.extension:comment Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. https://fhir.healthdata.be/StructureDefinition/ext-Comment Constraints
|
url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdConsent.extension:comment.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. System.String Fixed Valuehttps://fhir.healthdata.be/StructureDefinition/ext-Comment
| |
value[x] | 0..1 | Element IdConsent.extension:comment.value[x] Comment Alternate namesToelichting DefinitionComment on the living will: the form, such as a medallion, tattoo, etc., or where the living will can be found.
| ||
valueString | string | There are no (further) constraints on this element Data Type | ||
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element IdConsent.identifier Identifier for this record (external references) DefinitionUnique identifier for this copy of the Consent Statement. This identifier identifies this copy of the consent. Where this identifier is also used elsewhere as the identifier for a consent record (e.g. a CDA consent document) then the consent details are expected to be the same.
General { "system": "urn:ietf:rfc:3986", "value": "Local eCMS identifier" } Mappings
|
status | Σ ?! | 1..1 | codeBinding | Element IdConsent.status draft | proposed | active | rejected | inactive | entered-in-error DefinitionIndicates the current state of this consent. The Consent Directive that is pointed to might be in various lifecycle states, e.g., a revoked Consent Directive. This element has no functional counterpart in the CBB and cannot be implicitly mapped to other concepts. Unless a more appropriate status is recorded, it is assumed that only active Consent resources will be exchanged. Indicates the state of the consent. ConsentState (required)Constraints
|
scope | Σ ?! | 1..1 | CodeableConceptBinding | Element IdConsent.scope Which of the four areas this resource covers (extensible) DefinitionA selector of the type of consent being presented: ADR, Privacy, Treatment, Research. This list is now extensible. At the moment of writing (02-11-2021) the adr code is incorrectly removed from the ConsentScopeCodes CodeSystem (http://terminology.hl7.org/CodeSystem/consentscope). This will be corrected within the R4 release of FHIR based on this tracker item: https://jira.hl7.org/browse/FHIR-34215. The four anticipated uses for the Consent Resource. ConsentScopeCodes (extensible)Constraints
{ "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/consentscope", "code": "adr" } ] }
|
category | Σ | 1..* | CodeableConceptBinding | Element IdConsent.category Classification of the consent statement - for indexing/retrieval DefinitionA classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. A classification of the type of consents found in a consent statement. ConsentCategoryCodes (extensible)Constraints
{ "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/consentcategorycodes", "code": "acd" } ] }
|
patient | Σ I | 0..1 | Reference(Patient) | There are no (further) constraints on this element Element IdConsent.patient Who the consent applies to DefinitionThe patient/healthcare consumer to whom this consent applies. Commonly, the patient the consent pertains to is the author, but for young and old people, it may be some other person.
|
dateTime | Σ | 0..1 | dateTime | Element IdConsent.dateTime LivingWillDate Alternate namesWilsverklaringDatum DefinitionThe date on which the living will was recorded. This is not the time of the original consent, but the time that this statement was made or derived.
|
performer | Σ I | 0..* | Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | There are no (further) constraints on this element Element IdConsent.performer Who is agreeing to the policy and rules Alternate namesconsentor DefinitionEither the Grantor, which is the entity responsible for granting the rights listed in a Consent Directive or the Grantee, which is the entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations and enforcement of prohibitions. Commonly, the patient the consent pertains to is the consentor, but particularly for young and old people, it may be some other person - e.g. a legal guardian. Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) Constraints
|
organization | Σ I | 0..* | Reference(Organization) | There are no (further) constraints on this element Element IdConsent.organization Custodian of the consent Alternate namescustodian DefinitionThe organization that manages the consent, and the framework within which it is executed. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
source[x] | Σ | 0..1 | Element IdConsent.source[x] Source from which this consent is taken DefinitionThe source on which this consent statement is based. The source might be a scanned original paper form, or a reference to a consent that links back to such a source, a reference to a document repository (e.g. XDS) that stores the original consent document. The source can be contained inline (Attachment), referenced directly (Consent), referenced in a consent repository (DocumentReference), or simply by an identifier (Identifier), e.g. a CDA document id. Unordered, Open, by $this(Type) Constraints
| |
sourceReference | Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) | There are no (further) constraints on this element Data Type Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) | ||
sourceAttachment | Σ | 0..1 | Attachment | Element IdConsent.source[x]:sourceAttachment Source from which this consent is taken DefinitionThe source on which this consent statement is based. The source might be a scanned original paper form, or a reference to a consent that links back to such a source, a reference to a document repository (e.g. XDS) that stores the original consent document. The source can be contained inline (Attachment), referenced directly (Consent), referenced in a consent repository (DocumentReference), or simply by an identifier (Identifier), e.g. a CDA document id.
|
contentType | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element IdConsent.source[x]:sourceAttachment.contentType Mime type of the content, with charset etc. DefinitionIdentifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate. Processors of the data need to be able to know how to interpret the data. Note that FHIR strings SHALL NOT exceed 1MB in size The mime type of an attachment. Any valid mime type is allowed. Mime Types (required)Constraints
General text/plain; charset=UTF-8, image/png Mappings
|
language | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element IdConsent.source[x]:sourceAttachment.language Human language of the content (BCP-47) DefinitionThe human language of the content. The value can be any valid value according to BCP 47. Users need to be able to choose between the languages in a set of attachments. Note that FHIR strings SHALL NOT exceed 1MB in size A human language. CommonLanguages (preferred)Constraints
General en-AU Mappings
|
data | 0..1 | base64Binary | Element IdConsent.source[x]:sourceAttachment.data LivingWillDocument Alternate namesWilsverklaringDocument DefinitionScanned source document with the living will and the patient's signature, such as a PDF. The data needs to able to be transmitted inline. The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON.
| |
url | Σ | 0..1 | url | There are no (further) constraints on this element Element IdConsent.source[x]:sourceAttachment.url Uri where the data can be found DefinitionA location where the data can be accessed. The data needs to be transmitted by reference. If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data.
General http://www.acme.com/logo-small.png Mappings
|
size | Σ | 0..1 | unsignedInt | There are no (further) constraints on this element Element IdConsent.source[x]:sourceAttachment.size Number of bytes of content (if url provided) DefinitionThe number of bytes of data that make up this attachment (before base64 encoding, if that is done). Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all. The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference.
|
hash | Σ | 0..1 | base64Binary | There are no (further) constraints on this element Element IdConsent.source[x]:sourceAttachment.hash Hash of the data (sha-1, base64ed) DefinitionThe calculated hash of the data using SHA-1. Represented using base64. Included so that applications can verify that the contents of a location have not changed due to technical failures (e.g., storage rot, transport glitch, incorrect version). The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. The hash is not intended to support digital signatures. Where protection against malicious threats a digital signature should be considered, see Provenance.signature for mechanism to protect a resource with a digital signature.
|
title | Σ | 0..1 | string | There are no (further) constraints on this element Element IdConsent.source[x]:sourceAttachment.title Label to display in place of the data DefinitionA label or set of text to display in place of the data. Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer. Note that FHIR strings SHALL NOT exceed 1MB in size
General Official Corporate Logo Mappings
|
creation | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element IdConsent.source[x]:sourceAttachment.creation Date attachment was first created DefinitionThe date that the attachment was first created. This is often tracked as an integrity issue for use of the attachment.
|
policy | 0..* | BackboneElement | There are no (further) constraints on this element Element IdConsent.policy Policies covered by this consent DefinitionThe references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law.
| |
authority | I | 0..1 | uri | There are no (further) constraints on this element Element IdConsent.policy.authority Enforcement source for policy DefinitionEntity or Organization having regulatory jurisdiction or accountability for enforcing policies pertaining to Consent Directives. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
|
uri | I | 0..1 | uri | Element IdConsent.policy.uri Specific policy covered by this consent DefinitionThe references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law. Either
|
policyRule | Σ I | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdConsent.policyRule Regulation that this consents to DefinitionA reference to the specific base computable regulation or policy. Might be a unique identifier of a policy set in XACML, or other rules engine. If the policyRule is absent, computable consent would need to be constructed from the elements of the Consent resource. Regulatory policy examples. ConsentPolicyRuleCodes (extensible)Constraints
|
verification | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element IdConsent.verification Consent Verified by patient or family DefinitionWhether a treatment instruction (e.g. artificial respiration yes or no) was verified with the patient, his/her family or another authorized person.
|
verified | Σ | 1..1 | boolean | There are no (further) constraints on this element Element IdConsent.verification.verified Has been verified DefinitionHas the instruction been verified.
|
verifiedWith | I | 0..1 | Reference(Patient | RelatedPerson) | There are no (further) constraints on this element Element IdConsent.verification.verifiedWith Person who verified DefinitionWho verified the instruction (Patient, Relative or other Authorized Person). References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Patient | RelatedPerson) Constraints
|
verificationDate | 0..1 | dateTime | There are no (further) constraints on this element Element IdConsent.verification.verificationDate When consent verified DefinitionDate verification was collected.
| |
provision | Σ | 0..1 | BackboneElement | There are no (further) constraints on this element Element IdConsent.provision Constraints to the base Consent.policyRule DefinitionAn exception to the base policy of this consent. An exception can be an addition or removal of access permissions.
|
type | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element IdConsent.provision.type deny | permit DefinitionAction to take - permit or deny - when the rule conditions are met. Not permitted in root rule, required in all nested rules. Note that FHIR strings SHALL NOT exceed 1MB in size How a rule statement is applied, such as adding additional consent or removing consent. ConsentProvisionType (required)Constraints
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdConsent.provision.period Timeframe for this rule DefinitionThe timeframe in this rule is valid. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
actor | 0..* | BackboneElement | Element IdConsent.provision.actor Who|what controlled by this rule (or group, by role) DefinitionWho or what is controlled by this rule. Use group to identify a set of actors by some property they share (e.g. 'admitting officers'). Unordered, Open, by role(Value) Constraints
| |
(All Slices) | There are no (further) constraints on this element | |||
role | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdConsent.provision.actor.role How the actor is involved DefinitionHow the individual is involved in the resources content that is described in the exception. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. How an actor is involved in the consent considerations. SecurityRoleType (extensible)Constraints
| |
reference | I | 1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | There are no (further) constraints on this element Element IdConsent.provision.actor.reference Resource for the actor (or group, by role) DefinitionThe resource that identifies the actor. To identify actors by type, use group to identify a set of actors by some property they share (e.g. 'admitting officers'). References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) Constraints
|
representative | 0..* | BackboneElement | There are no (further) constraints on this element Element IdConsent.provision.actor:representative Who|what controlled by this rule (or group, by role) DefinitionWho or what is controlled by this rule. Use group to identify a set of actors by some property they share (e.g. 'admitting officers').
| |
role | 1..1 | CodeableConceptBinding | Element IdConsent.provision.actor:representative.role How the actor is involved DefinitionHow the individual is involved in the resources content that is described in the exception. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. How an actor is involved in the consent considerations. SecurityRoleType (extensible)Constraints
{ "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode", "code": "RESPRSN" } ] }
| |
reference | I | 1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole | HdBe ContactPerson) | Element IdConsent.provision.actor:representative.reference Representative Alternate namesVertegenwoordiger DefinitionThe person who is the legal representative or is appointed as the authorized representative in the signed authorization. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole | HdBe ContactPerson) Constraints
|
action | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element IdConsent.provision.action Actions controlled by this rule DefinitionActions controlled by this Rule. Note that this is the direct action (not the grounds for the action covered in the purpose element). At present, the only action in the understood and tested scope of this resource is 'read'. Detailed codes for the consent action. ConsentActionCodes (example)Constraints
|
securityLabel | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element IdConsent.provision.securityLabel Security Labels that define affected resources DefinitionA security label, comprised of 0..* security label fields (Privacy tags), which define which resources are controlled by this exception. If the consent specifies a security label of "R" then it applies to all resources that are labeled "R" or lower. E.g. for Confidentiality, it's a high water mark. For other kinds of security labels, subsumption logic applies. When the purpose of use tag is on the data, access request purpose of use shall not conflict. Security Labels from the Healthcare Privacy and Security Classification System. All Security Labels (extensible)Constraints
|
purpose | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element IdConsent.provision.purpose Context of activities covered by this rule DefinitionThe context of the activities a user is taking - why the user is accessing the data - that are controlled by this rule. When the purpose of use tag is on the data, access request purpose of use shall not conflict. What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels. v3.PurposeOfUse (extensible)Constraints
|
class | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element IdConsent.provision.class e.g. Resource Type, Profile, CDA, etc. DefinitionThe class of information covered by this rule. The type can be a FHIR resource type, a profile on a type, or a CDA document, or some other type that indicates what sort of information the consent relates to. Multiple types are or'ed together. The intention of the contentType element is that the codes refer to profiles or document types defined in a standard or an implementation guide somewhere. The class (type) of information a consent rule covers. ConsentContentClass (extensible)Constraints
|
code | Σ | 0..1 | CodeableConceptBinding | Element IdConsent.provision.code LivingWillType Alternate namesWilsverklaringType DefinitionThe type of living will. Typical use of this is a Document code with class = CDA. If this code is found in an instance, then the exception applies. TypeOfLivingWill (extensible)Constraints
|
dataPeriod | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdConsent.provision.dataPeriod Timeframe for data controlled by this rule DefinitionClinical or Operational Relevant period of time that bounds the data controlled by this rule. This has a different sense to the Consent.period - that is when the consent agreement holds. This is the time period of the data that is controlled by the agreement.
|
data | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element IdConsent.provision.data Data controlled by this rule DefinitionThe resources controlled by this rule if specific resources are referenced.
|
meaning | Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element IdConsent.provision.data.meaning instance | related | dependents | authoredby DefinitionHow the resource reference is interpreted when testing consent restrictions. Note that FHIR strings SHALL NOT exceed 1MB in size How a resource reference is interpreted when testing consent restrictions. ConsentDataMeaning (required)Constraints
|
reference | Σ I | 1..1 | Reference(Resource) | There are no (further) constraints on this element Element IdConsent.provision.data.reference The actual data reference DefinitionA reference to a specific resource that defines which resources are covered by this consent. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
provision | 0..* | see (provision) | There are no (further) constraints on this element Element IdConsent.provision.provision Nested Exception Rules DefinitionRules which provide exceptions to the base rule or subrules. |
Consent | I | Consent | Element IdConsent AdvanceDirective Alternate namesWilsverklaring DefinitionA record of a healthcare consumer’s choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time. Broadly, there are 3 key areas of consent for patients: Consent around sharing information (aka Privacy Consent Directive - Authorization to Collect, Use, or Disclose information), consent for specific treatment, or kinds of treatment, and general advance care directives.
| |
extension | I | 0..* | Extension | Element IdConsent.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Constraints
|
disorder | I | 0..* | Extension(Reference(HdBe Problem)) | Element IdConsent.extension:disorder Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Extension(Reference(HdBe Problem)) Extension URLhttps://fhir.healthdata.be/StructureDefinition/ext-AdvanceDirective.Disorder Constraints
|
comment | I | 0..1 | Extension(string) | Element IdConsent.extension:comment Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. https://fhir.healthdata.be/StructureDefinition/ext-Comment Constraints
|
url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdConsent.extension:comment.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. System.String Fixed Valuehttps://fhir.healthdata.be/StructureDefinition/ext-Comment
| |
value[x] | 0..1 | Element IdConsent.extension:comment.value[x] Comment Alternate namesToelichting DefinitionComment on the living will: the form, such as a medallion, tattoo, etc., or where the living will can be found.
| ||
valueString | string | There are no (further) constraints on this element Data Type | ||
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element IdConsent.identifier Identifier for this record (external references) DefinitionUnique identifier for this copy of the Consent Statement. This identifier identifies this copy of the consent. Where this identifier is also used elsewhere as the identifier for a consent record (e.g. a CDA consent document) then the consent details are expected to be the same.
General { "system": "urn:ietf:rfc:3986", "value": "Local eCMS identifier" } Mappings
|
status | Σ ?! | 1..1 | codeBinding | Element IdConsent.status draft | proposed | active | rejected | inactive | entered-in-error DefinitionIndicates the current state of this consent. The Consent Directive that is pointed to might be in various lifecycle states, e.g., a revoked Consent Directive. This element has no functional counterpart in the CBB and cannot be implicitly mapped to other concepts. Unless a more appropriate status is recorded, it is assumed that only active Consent resources will be exchanged. Indicates the state of the consent. ConsentState (required)Constraints
|
scope | Σ ?! | 1..1 | CodeableConceptBinding | Element IdConsent.scope Which of the four areas this resource covers (extensible) DefinitionA selector of the type of consent being presented: ADR, Privacy, Treatment, Research. This list is now extensible. At the moment of writing (02-11-2021) the adr code is incorrectly removed from the ConsentScopeCodes CodeSystem (http://terminology.hl7.org/CodeSystem/consentscope). This will be corrected within the R4 release of FHIR based on this tracker item: https://jira.hl7.org/browse/FHIR-34215. The four anticipated uses for the Consent Resource. ConsentScopeCodes (extensible)Constraints
{ "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/consentscope", "code": "adr" } ] }
|
category | Σ | 1..* | CodeableConceptBinding | Element IdConsent.category Classification of the consent statement - for indexing/retrieval DefinitionA classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. A classification of the type of consents found in a consent statement. ConsentCategoryCodes (extensible)Constraints
{ "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/consentcategorycodes", "code": "acd" } ] }
|
patient | Σ I | 0..1 | Reference(Patient) | There are no (further) constraints on this element Element IdConsent.patient Who the consent applies to DefinitionThe patient/healthcare consumer to whom this consent applies. Commonly, the patient the consent pertains to is the author, but for young and old people, it may be some other person.
|
dateTime | Σ | 0..1 | dateTime | Element IdConsent.dateTime LivingWillDate Alternate namesWilsverklaringDatum DefinitionThe date on which the living will was recorded. This is not the time of the original consent, but the time that this statement was made or derived.
|
performer | Σ I | 0..* | Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | There are no (further) constraints on this element Element IdConsent.performer Who is agreeing to the policy and rules Alternate namesconsentor DefinitionEither the Grantor, which is the entity responsible for granting the rights listed in a Consent Directive or the Grantee, which is the entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations and enforcement of prohibitions. Commonly, the patient the consent pertains to is the consentor, but particularly for young and old people, it may be some other person - e.g. a legal guardian. Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) Constraints
|
organization | Σ I | 0..* | Reference(Organization) | There are no (further) constraints on this element Element IdConsent.organization Custodian of the consent Alternate namescustodian DefinitionThe organization that manages the consent, and the framework within which it is executed. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
source[x] | Σ | 0..1 | Element IdConsent.source[x] Source from which this consent is taken DefinitionThe source on which this consent statement is based. The source might be a scanned original paper form, or a reference to a consent that links back to such a source, a reference to a document repository (e.g. XDS) that stores the original consent document. The source can be contained inline (Attachment), referenced directly (Consent), referenced in a consent repository (DocumentReference), or simply by an identifier (Identifier), e.g. a CDA document id. Unordered, Open, by $this(Type) Constraints
| |
sourceReference | Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) | There are no (further) constraints on this element Data Type Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) | ||
sourceAttachment | Σ | 0..1 | Attachment | Element IdConsent.source[x]:sourceAttachment Source from which this consent is taken DefinitionThe source on which this consent statement is based. The source might be a scanned original paper form, or a reference to a consent that links back to such a source, a reference to a document repository (e.g. XDS) that stores the original consent document. The source can be contained inline (Attachment), referenced directly (Consent), referenced in a consent repository (DocumentReference), or simply by an identifier (Identifier), e.g. a CDA document id.
|
contentType | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element IdConsent.source[x]:sourceAttachment.contentType Mime type of the content, with charset etc. DefinitionIdentifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate. Processors of the data need to be able to know how to interpret the data. Note that FHIR strings SHALL NOT exceed 1MB in size The mime type of an attachment. Any valid mime type is allowed. Mime Types (required)Constraints
General text/plain; charset=UTF-8, image/png Mappings
|
language | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element IdConsent.source[x]:sourceAttachment.language Human language of the content (BCP-47) DefinitionThe human language of the content. The value can be any valid value according to BCP 47. Users need to be able to choose between the languages in a set of attachments. Note that FHIR strings SHALL NOT exceed 1MB in size A human language. CommonLanguages (preferred)Constraints
General en-AU Mappings
|
data | 0..1 | base64Binary | Element IdConsent.source[x]:sourceAttachment.data LivingWillDocument Alternate namesWilsverklaringDocument DefinitionScanned source document with the living will and the patient's signature, such as a PDF. The data needs to able to be transmitted inline. The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON.
| |
url | Σ | 0..1 | url | There are no (further) constraints on this element Element IdConsent.source[x]:sourceAttachment.url Uri where the data can be found DefinitionA location where the data can be accessed. The data needs to be transmitted by reference. If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data.
General http://www.acme.com/logo-small.png Mappings
|
size | Σ | 0..1 | unsignedInt | There are no (further) constraints on this element Element IdConsent.source[x]:sourceAttachment.size Number of bytes of content (if url provided) DefinitionThe number of bytes of data that make up this attachment (before base64 encoding, if that is done). Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all. The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference.
|
hash | Σ | 0..1 | base64Binary | There are no (further) constraints on this element Element IdConsent.source[x]:sourceAttachment.hash Hash of the data (sha-1, base64ed) DefinitionThe calculated hash of the data using SHA-1. Represented using base64. Included so that applications can verify that the contents of a location have not changed due to technical failures (e.g., storage rot, transport glitch, incorrect version). The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. The hash is not intended to support digital signatures. Where protection against malicious threats a digital signature should be considered, see Provenance.signature for mechanism to protect a resource with a digital signature.
|
title | Σ | 0..1 | string | There are no (further) constraints on this element Element IdConsent.source[x]:sourceAttachment.title Label to display in place of the data DefinitionA label or set of text to display in place of the data. Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer. Note that FHIR strings SHALL NOT exceed 1MB in size
General Official Corporate Logo Mappings
|
creation | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element IdConsent.source[x]:sourceAttachment.creation Date attachment was first created DefinitionThe date that the attachment was first created. This is often tracked as an integrity issue for use of the attachment.
|
policy | 0..* | BackboneElement | There are no (further) constraints on this element Element IdConsent.policy Policies covered by this consent DefinitionThe references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law.
| |
authority | I | 0..1 | uri | There are no (further) constraints on this element Element IdConsent.policy.authority Enforcement source for policy DefinitionEntity or Organization having regulatory jurisdiction or accountability for enforcing policies pertaining to Consent Directives. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
|
uri | I | 0..1 | uri | Element IdConsent.policy.uri Specific policy covered by this consent DefinitionThe references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law. Either
|
policyRule | Σ I | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdConsent.policyRule Regulation that this consents to DefinitionA reference to the specific base computable regulation or policy. Might be a unique identifier of a policy set in XACML, or other rules engine. If the policyRule is absent, computable consent would need to be constructed from the elements of the Consent resource. Regulatory policy examples. ConsentPolicyRuleCodes (extensible)Constraints
|
verification | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element IdConsent.verification Consent Verified by patient or family DefinitionWhether a treatment instruction (e.g. artificial respiration yes or no) was verified with the patient, his/her family or another authorized person.
|
verified | Σ | 1..1 | boolean | There are no (further) constraints on this element Element IdConsent.verification.verified Has been verified DefinitionHas the instruction been verified.
|
verifiedWith | I | 0..1 | Reference(Patient | RelatedPerson) | There are no (further) constraints on this element Element IdConsent.verification.verifiedWith Person who verified DefinitionWho verified the instruction (Patient, Relative or other Authorized Person). References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Patient | RelatedPerson) Constraints
|
verificationDate | 0..1 | dateTime | There are no (further) constraints on this element Element IdConsent.verification.verificationDate When consent verified DefinitionDate verification was collected.
| |
provision | Σ | 0..1 | BackboneElement | There are no (further) constraints on this element Element IdConsent.provision Constraints to the base Consent.policyRule DefinitionAn exception to the base policy of this consent. An exception can be an addition or removal of access permissions.
|
type | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element IdConsent.provision.type deny | permit DefinitionAction to take - permit or deny - when the rule conditions are met. Not permitted in root rule, required in all nested rules. Note that FHIR strings SHALL NOT exceed 1MB in size How a rule statement is applied, such as adding additional consent or removing consent. ConsentProvisionType (required)Constraints
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdConsent.provision.period Timeframe for this rule DefinitionThe timeframe in this rule is valid. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
actor | 0..* | BackboneElement | Element IdConsent.provision.actor Who|what controlled by this rule (or group, by role) DefinitionWho or what is controlled by this rule. Use group to identify a set of actors by some property they share (e.g. 'admitting officers'). Unordered, Open, by role(Value) Constraints
| |
(All Slices) | There are no (further) constraints on this element | |||
role | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdConsent.provision.actor.role How the actor is involved DefinitionHow the individual is involved in the resources content that is described in the exception. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. How an actor is involved in the consent considerations. SecurityRoleType (extensible)Constraints
| |
reference | I | 1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | There are no (further) constraints on this element Element IdConsent.provision.actor.reference Resource for the actor (or group, by role) DefinitionThe resource that identifies the actor. To identify actors by type, use group to identify a set of actors by some property they share (e.g. 'admitting officers'). References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) Constraints
|
representative | 0..* | BackboneElement | There are no (further) constraints on this element Element IdConsent.provision.actor:representative Who|what controlled by this rule (or group, by role) DefinitionWho or what is controlled by this rule. Use group to identify a set of actors by some property they share (e.g. 'admitting officers').
| |
role | 1..1 | CodeableConceptBinding | Element IdConsent.provision.actor:representative.role How the actor is involved DefinitionHow the individual is involved in the resources content that is described in the exception. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. How an actor is involved in the consent considerations. SecurityRoleType (extensible)Constraints
{ "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode", "code": "RESPRSN" } ] }
| |
reference | I | 1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole | HdBe ContactPerson) | Element IdConsent.provision.actor:representative.reference Representative Alternate namesVertegenwoordiger DefinitionThe person who is the legal representative or is appointed as the authorized representative in the signed authorization. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole | HdBe ContactPerson) Constraints
|
action | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element IdConsent.provision.action Actions controlled by this rule DefinitionActions controlled by this Rule. Note that this is the direct action (not the grounds for the action covered in the purpose element). At present, the only action in the understood and tested scope of this resource is 'read'. Detailed codes for the consent action. ConsentActionCodes (example)Constraints
|
securityLabel | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element IdConsent.provision.securityLabel Security Labels that define affected resources DefinitionA security label, comprised of 0..* security label fields (Privacy tags), which define which resources are controlled by this exception. If the consent specifies a security label of "R" then it applies to all resources that are labeled "R" or lower. E.g. for Confidentiality, it's a high water mark. For other kinds of security labels, subsumption logic applies. When the purpose of use tag is on the data, access request purpose of use shall not conflict. Security Labels from the Healthcare Privacy and Security Classification System. All Security Labels (extensible)Constraints
|
purpose | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element IdConsent.provision.purpose Context of activities covered by this rule DefinitionThe context of the activities a user is taking - why the user is accessing the data - that are controlled by this rule. When the purpose of use tag is on the data, access request purpose of use shall not conflict. What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels. v3.PurposeOfUse (extensible)Constraints
|
class | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element IdConsent.provision.class e.g. Resource Type, Profile, CDA, etc. DefinitionThe class of information covered by this rule. The type can be a FHIR resource type, a profile on a type, or a CDA document, or some other type that indicates what sort of information the consent relates to. Multiple types are or'ed together. The intention of the contentType element is that the codes refer to profiles or document types defined in a standard or an implementation guide somewhere. The class (type) of information a consent rule covers. ConsentContentClass (extensible)Constraints
|
code | Σ | 0..1 | CodeableConceptBinding | Element IdConsent.provision.code LivingWillType Alternate namesWilsverklaringType DefinitionThe type of living will. Typical use of this is a Document code with class = CDA. If this code is found in an instance, then the exception applies. TypeOfLivingWill (extensible)Constraints
|
dataPeriod | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdConsent.provision.dataPeriod Timeframe for data controlled by this rule DefinitionClinical or Operational Relevant period of time that bounds the data controlled by this rule. This has a different sense to the Consent.period - that is when the consent agreement holds. This is the time period of the data that is controlled by the agreement.
|
data | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element IdConsent.provision.data Data controlled by this rule DefinitionThe resources controlled by this rule if specific resources are referenced.
|
meaning | Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element IdConsent.provision.data.meaning instance | related | dependents | authoredby DefinitionHow the resource reference is interpreted when testing consent restrictions. Note that FHIR strings SHALL NOT exceed 1MB in size How a resource reference is interpreted when testing consent restrictions. ConsentDataMeaning (required)Constraints
|
reference | Σ I | 1..1 | Reference(Resource) | There are no (further) constraints on this element Element IdConsent.provision.data.reference The actual data reference DefinitionA reference to a specific resource that defines which resources are covered by this consent. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
provision | 0..* | see (provision) | There are no (further) constraints on this element Element IdConsent.provision.provision Nested Exception Rules DefinitionRules which provide exceptions to the base rule or subrules. |
Mapping FHIR profile to CBB
Path | map | CBB |
---|---|---|
Consent | AdvanceDirective | HdBe-AdvanceDirective |
Consent.extension:comment.value[x] | AdvanceDirective.Comment | HdBe-AdvanceDirective |
Consent.dateTime | AdvanceDirective.LivingWillDate | HdBe-AdvanceDirective |
Consent.source[x]:sourceAttachment.data | AdvanceDirective.LivingWillDocument | HdBe-AdvanceDirective |
Consent.provision.actor:representative.reference | AdvanceDirective.Representative | HdBe-AdvanceDirective |
Consent.provision.code | AdvanceDirective.LivingWillType | HdBe-AdvanceDirective |
zib AdvanceDirective difference
Concept | Category | Description |
---|---|---|
StructureDefinition.description |
textual | Replaced LivingWill with AdvanceDirective where appopriate. (zib ticket #1597). |
policy.uri |
textual | Replaced Dutch context about Dutch law and the uri https://wetten.overheid.nl with Belgian context and default uri of https://www.belgielex.be/. |
provision.actor:representative |
cardinality | Loosened the cardinality from 0..1 to 0..* (zib ticket #1557). |
provision.code |
textual | Improved text (zib ticket #1587). |
provision.code |
terminology | Included NL SNOMED codes based on the codes found in the AdvanceDirective-v4.1(2022EN) LivingWillTypeSnomedCodelist. This needs to become International codes or codes available in the BE edition. (zib-1683)) Also made the ValueSet binding strenght Extensible instead of Required which is inline with the future version of the zib as well. |
Terminology Bindings
Path | Name | Strength | URL | ConceptMap |
---|---|---|---|---|
Consent.provision.code | TypeOfLivingWill | extensible | https://fhir.healthdata.be/ValueSet/TypeOfLivingWill | No bound ConceptMap |