HdBe-TreatmentDirective2
Profile | Description | Status | URL |
---|---|---|---|
HdBe-TreatmentDirective2 | A treatment directive contains a joint decision between a health professional (for example a general practitioner) and a patient or his representative(s) about the desirability of performing a certain treatment, such as resuscitation, before this treatment becomes (acute) necessary. When the need arises and the treatment cannot be discussed with the patient or representative (s), that decision is an important indication for the treating health professional (for example an ER doctor). The term treatment limit is a synonym of the term treatment directive. | draft | https://fhir.healthdata.be/StructureDefinition/HdBe-TreatmentDirective2 |
Information |
---|
A straightforward and fitting mapping of TreatmentDirective2 to FHIR was not possible. The main considerations were between mapping to the Consent and CarePlan resource. Unfortunately, the Consent resource does not have full support for treatment directives yet as its main focus was modelling Patient's privacy consents. However, it seems to be the most fitting resource for the CBB intention. The CBB describes a mutual agreement about treatments, not necessarily the direct actions or policy for treatments. The latter would be more fitting in the CarePlan resource. Future migration to a higher version of FHIR or the CBB will result in the reevaluation of the mapping. |
Consent | I | Consent | Element IdConsent TreatmentDirective Alternate namesBehandelAanwijzing 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. A straightforward and fitting mapping of TreatmentDirective2 to FHIR was not possible. The main considerations were between mapping to the Consent and CarePlan resource. Unfortunately, the Consent resource does not have full support for treatment directives yet as its main focus was modelling Patient's privacy consents. However, it seems to be the most fitting resource for the CBB intention. The CBB describes a mutual agreement about treatments, not necessarily the direct actions or policy for treatments. The latter would be more fitting in the CarePlan resource. Future migration to a higher version of FHIR or the CBB will result in the reevaluation of the mapping.
| |
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
|
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 DefinitionThe comment may include further information such as the reason why a treatment directive has been drawn up, persons who assisted the patient in agreeing the treatment directive but who are not otherwise involved in the agreement as a representative, etc.
| ||
valueString | string | There are no (further) constraints on this element Data Type | ||
additionalAdvanceDirective | I | 0..* | Extension(Reference(HdBe AdvanceDirective)) | Element IdConsent.extension:additionalAdvanceDirective Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. The cardinality of the Extension(Reference(HdBe AdvanceDirective)) Extension URLhttps://fhir.healthdata.be/StructureDefinition/ext-TreatmentDirective2.AdvanceDirective Constraints
|
url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdConsent.extension:additionalAdvanceDirective.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-TreatmentDirective2.AdvanceDirective
| |
value[x] | I | 0..1 | Element IdConsent.extension:additionalAdvanceDirective.value[x] AdvanceDirective Alternate namesWilsverklaring DefinitionA (written) statement in which a person indicates wishes concerning future medical action, in the event that this person is at that point no longer (deemed) capable of taking decisions on the matter.
| |
valueReference | Reference(HdBe AdvanceDirective) | There are no (further) constraints on this element Data Type | ||
modifierExtension | ?! I | 0..* | Extension | Element IdConsent.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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
|
specificationOther | ?! I | 0..1 | Extension(string) | Element IdConsent.modifierExtension:specificationOther Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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-TreatmentDirective2.SpecificationOther Constraints
|
url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdConsent.modifierExtension:specificationOther.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-TreatmentDirective2.SpecificationOther
| |
value[x] | I | 0..1 | Element IdConsent.modifierExtension:specificationOther.value[x] SpecificationOther Alternate namesSpecificatieAnders DefinitionSpecification of the treatment decision when the decision is 'Other'.
| |
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 is implicitly mapped to the concepts MostRecentReviewDate and DateExpired. Unless the status is explicitly recorded, the following guidance applies:
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. 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. The four anticipated uses for the Consent Resource. ConsentScopeCodes (extensible)Constraints
{ "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/consentscope", "code": "treatment" } ] }
|
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://snomed.info/sct", "code": "129125009" } ] }
|
patient | Σ I | 0..1 | Reference(Patient | HdBe Patient) | 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. Reference(Patient | HdBe Patient) Constraints
|
dateTime | Σ | 0..1 | dateTime | Element IdConsent.dateTime MostRecentReviewDate Alternate namesMeestRecenteBespreekdatum DefinitionThe date on which the treatment directive has been agreed is with the patient and / or his representative (s). This can be the first time that the treatment directive have been discussed, but an existing treatment directive may also have been discussed again. The content of the treatment directive may have changed or remained the same. 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] | Σ I | 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
| |
sourceAttachment | Attachment | There are no (further) constraints on this element Data Type | ||
sourceReference | Σ I | 0..1 | Reference(Consent | DocumentReference | Contract | QuestionnaireResponse | HdBe AdvanceDirective) | Element IdConsent.source[x]:sourceReference AdvanceDirective Alternate namesWilsverklaring DefinitionA (written) statement in which a person indicates wishes concerning future medical action, in the event that this person is at that point no longer (deemed) capable of taking decisions on the matter. 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. Reference(Consent | DocumentReference | Contract | QuestionnaireResponse | HdBe AdvanceDirective) Constraints
|
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.
|
extension | I | 0..* | Extension | Element IdConsent.provision.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 element. 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
|
reasonForEnding | I | 0..1 | Extension(string) | Element IdConsent.provision.extension:reasonForEnding 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-TreatmentDirective2.ReasonForEnding Constraints
|
url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdConsent.provision.extension:reasonForEnding.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-TreatmentDirective2.ReasonForEnding
| |
value[x] | 0..1 | Element IdConsent.provision.extension:reasonForEnding.value[x] ReasonForEnding Alternate namesRedenBeeindigd DefinitionReason why the agreement on a treatment directive no longer applies.
| ||
valueString | string | There are no (further) constraints on this element Data Type | ||
type | Σ I | 0..1 | codeBinding | Element IdConsent.provision.type TreatmentDecision Alternate namesBehandelBesluit DefinitionThe joint decision taken with regard to the desirability of performing the indicated treatment. If the agreement is 'Other', 'Specification Other' shall contain the instructions for whether or not to carry out the treatment. Implementers SHALL support the SpecificationOther extension on Note that FHIR strings SHALL NOT exceed 1MB in size Use ConceptMap 'TreatmentDecision-to-ConsentProvisionType' to translate zib terminology to profile terminology in ValueSet 'ConsentProvisionType' ConsentProvisionType (required)Permitted Values TreatmentDecision_to_ConsentProvisionType 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.
|
start | Σ I | 0..1 | dateTime | There are no (further) constraints on this element Element IdConsent.provision.period.start Starting time with inclusive boundary DefinitionThe start of the period. The boundary is inclusive. If the low element is missing, the meaning is that the low boundary is not known.
|
end | Σ I | 0..1 | dateTime | Element IdConsent.provision.period.end DateExpired Alternate namesDatumBeeindigd DefinitionThe date on which the treatment directive has been withdrawn and therefore no longer applies. An explicit decision must be taken about the 'date expired', in consultation between the responsible care provider and the patient or his representative(s).Any future termination can only be entered as a condition. Often this will be linked to 1 or more events. The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.
|
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
|
agreementParty | 0..* | BackboneElement | Element IdConsent.provision.actor:agreementParty AgreementParty Alternate namesAfspraakPartij DefinitionContainer of the Agreement concept.This container contains all data elements of the Agreement concept.
| |
role | 1..1 | CodeableConceptBinding | Element IdConsent.provision.actor:agreementParty.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": "CONSENTER" } ] }
| |
reference | I | 1..1 | pattern HealthProfessional Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole | HdBe Patient | HdBe ContactPerson | HdBe HealthProfessional PractitionerRole) | Element IdConsent.provision.actor:agreementParty.reference Patient / Representative / HealthProfessional Alternate namesPatient, Vertegenwoordiger, Zorgverlener Definition
Each occurrence of the CBB HealthProfessional is normally represented by two FHIR resources: a PractitionerRole resource (instance of HdBe-HealthProfessional-PractitionerRole) and a Practitioner resource (instance of HdBe-HealthProfessional-Practitioner). The Practitioner resource is referenced from the PractitionerRole instance. For this reason, sending systems should fill the reference to the PractitionerRole instance here, and not the Practitioner resource. Receiving systems can then retrieve the reference to the Practitioner resource from that PractitionerRole instance. In rare circumstances, there is only a Practitioner instance, in which case it is that instance which will be referenced here. However, since this should be the exception, the HdBe-HealthProfessional-Practitioner profile is not explicitly mentioned as a target profile. pattern HealthProfessional Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole | HdBe Patient | HdBe ContactPerson | HdBe HealthProfessional PractitionerRole) 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 Treatment Alternate namesBehandeling DefinitionThe medical treatment to which the treatment instruction applies. Typical use of this is a Document code with class = CDA. If this code is found in an instance, then the exception applies. Treatment (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 TreatmentDirective Alternate namesBehandelAanwijzing 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. A straightforward and fitting mapping of TreatmentDirective2 to FHIR was not possible. The main considerations were between mapping to the Consent and CarePlan resource. Unfortunately, the Consent resource does not have full support for treatment directives yet as its main focus was modelling Patient's privacy consents. However, it seems to be the most fitting resource for the CBB intention. The CBB describes a mutual agreement about treatments, not necessarily the direct actions or policy for treatments. The latter would be more fitting in the CarePlan resource. Future migration to a higher version of FHIR or the CBB will result in the reevaluation of the mapping.
| |
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
|
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 DefinitionThe comment may include further information such as the reason why a treatment directive has been drawn up, persons who assisted the patient in agreeing the treatment directive but who are not otherwise involved in the agreement as a representative, etc.
| ||
valueString | string | There are no (further) constraints on this element Data Type | ||
additionalAdvanceDirective | I | 0..* | Extension(Reference(HdBe AdvanceDirective)) | Element IdConsent.extension:additionalAdvanceDirective Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. The cardinality of the Extension(Reference(HdBe AdvanceDirective)) Extension URLhttps://fhir.healthdata.be/StructureDefinition/ext-TreatmentDirective2.AdvanceDirective Constraints
|
url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdConsent.extension:additionalAdvanceDirective.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-TreatmentDirective2.AdvanceDirective
| |
value[x] | I | 0..1 | Element IdConsent.extension:additionalAdvanceDirective.value[x] AdvanceDirective Alternate namesWilsverklaring DefinitionA (written) statement in which a person indicates wishes concerning future medical action, in the event that this person is at that point no longer (deemed) capable of taking decisions on the matter.
| |
valueReference | Reference(HdBe AdvanceDirective) | There are no (further) constraints on this element Data Type | ||
modifierExtension | ?! I | 0..* | Extension | Element IdConsent.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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
|
specificationOther | ?! I | 0..1 | Extension(string) | Element IdConsent.modifierExtension:specificationOther Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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-TreatmentDirective2.SpecificationOther Constraints
|
url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdConsent.modifierExtension:specificationOther.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-TreatmentDirective2.SpecificationOther
| |
value[x] | I | 0..1 | Element IdConsent.modifierExtension:specificationOther.value[x] SpecificationOther Alternate namesSpecificatieAnders DefinitionSpecification of the treatment decision when the decision is 'Other'.
| |
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 is implicitly mapped to the concepts MostRecentReviewDate and DateExpired. Unless the status is explicitly recorded, the following guidance applies:
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. 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. The four anticipated uses for the Consent Resource. ConsentScopeCodes (extensible)Constraints
{ "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/consentscope", "code": "treatment" } ] }
|
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://snomed.info/sct", "code": "129125009" } ] }
|
patient | Σ I | 0..1 | Reference(Patient | HdBe Patient) | 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. Reference(Patient | HdBe Patient) Constraints
|
dateTime | Σ | 0..1 | dateTime | Element IdConsent.dateTime MostRecentReviewDate Alternate namesMeestRecenteBespreekdatum DefinitionThe date on which the treatment directive has been agreed is with the patient and / or his representative (s). This can be the first time that the treatment directive have been discussed, but an existing treatment directive may also have been discussed again. The content of the treatment directive may have changed or remained the same. 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] | Σ I | 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
| |
sourceAttachment | Attachment | There are no (further) constraints on this element Data Type | ||
sourceReference | Σ I | 0..1 | Reference(Consent | DocumentReference | Contract | QuestionnaireResponse | HdBe AdvanceDirective) | Element IdConsent.source[x]:sourceReference AdvanceDirective Alternate namesWilsverklaring DefinitionA (written) statement in which a person indicates wishes concerning future medical action, in the event that this person is at that point no longer (deemed) capable of taking decisions on the matter. 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. Reference(Consent | DocumentReference | Contract | QuestionnaireResponse | HdBe AdvanceDirective) Constraints
|
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.
|
extension | I | 0..* | Extension | Element IdConsent.provision.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 element. 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
|
reasonForEnding | I | 0..1 | Extension(string) | Element IdConsent.provision.extension:reasonForEnding 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-TreatmentDirective2.ReasonForEnding Constraints
|
url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdConsent.provision.extension:reasonForEnding.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-TreatmentDirective2.ReasonForEnding
| |
value[x] | 0..1 | Element IdConsent.provision.extension:reasonForEnding.value[x] ReasonForEnding Alternate namesRedenBeeindigd DefinitionReason why the agreement on a treatment directive no longer applies.
| ||
valueString | string | There are no (further) constraints on this element Data Type | ||
type | Σ I | 0..1 | codeBinding | Element IdConsent.provision.type TreatmentDecision Alternate namesBehandelBesluit DefinitionThe joint decision taken with regard to the desirability of performing the indicated treatment. If the agreement is 'Other', 'Specification Other' shall contain the instructions for whether or not to carry out the treatment. Implementers SHALL support the SpecificationOther extension on Note that FHIR strings SHALL NOT exceed 1MB in size Use ConceptMap 'TreatmentDecision-to-ConsentProvisionType' to translate zib terminology to profile terminology in ValueSet 'ConsentProvisionType' ConsentProvisionType (required)Permitted Values TreatmentDecision_to_ConsentProvisionType 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.
|
start | Σ I | 0..1 | dateTime | There are no (further) constraints on this element Element IdConsent.provision.period.start Starting time with inclusive boundary DefinitionThe start of the period. The boundary is inclusive. If the low element is missing, the meaning is that the low boundary is not known.
|
end | Σ I | 0..1 | dateTime | Element IdConsent.provision.period.end DateExpired Alternate namesDatumBeeindigd DefinitionThe date on which the treatment directive has been withdrawn and therefore no longer applies. An explicit decision must be taken about the 'date expired', in consultation between the responsible care provider and the patient or his representative(s).Any future termination can only be entered as a condition. Often this will be linked to 1 or more events. The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.
|
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
|
agreementParty | 0..* | BackboneElement | Element IdConsent.provision.actor:agreementParty AgreementParty Alternate namesAfspraakPartij DefinitionContainer of the Agreement concept.This container contains all data elements of the Agreement concept.
| |
role | 1..1 | CodeableConceptBinding | Element IdConsent.provision.actor:agreementParty.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": "CONSENTER" } ] }
| |
reference | I | 1..1 | pattern HealthProfessional Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole | HdBe Patient | HdBe ContactPerson | HdBe HealthProfessional PractitionerRole) | Element IdConsent.provision.actor:agreementParty.reference Patient / Representative / HealthProfessional Alternate namesPatient, Vertegenwoordiger, Zorgverlener Definition
Each occurrence of the CBB HealthProfessional is normally represented by two FHIR resources: a PractitionerRole resource (instance of HdBe-HealthProfessional-PractitionerRole) and a Practitioner resource (instance of HdBe-HealthProfessional-Practitioner). The Practitioner resource is referenced from the PractitionerRole instance. For this reason, sending systems should fill the reference to the PractitionerRole instance here, and not the Practitioner resource. Receiving systems can then retrieve the reference to the Practitioner resource from that PractitionerRole instance. In rare circumstances, there is only a Practitioner instance, in which case it is that instance which will be referenced here. However, since this should be the exception, the HdBe-HealthProfessional-Practitioner profile is not explicitly mentioned as a target profile. pattern HealthProfessional Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole | HdBe Patient | HdBe ContactPerson | HdBe HealthProfessional PractitionerRole) 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 Treatment Alternate namesBehandeling DefinitionThe medical treatment to which the treatment instruction applies. Typical use of this is a Document code with class = CDA. If this code is found in an instance, then the exception applies. Treatment (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 TreatmentDirective Alternate namesBehandelAanwijzing 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. A straightforward and fitting mapping of TreatmentDirective2 to FHIR was not possible. The main considerations were between mapping to the Consent and CarePlan resource. Unfortunately, the Consent resource does not have full support for treatment directives yet as its main focus was modelling Patient's privacy consents. However, it seems to be the most fitting resource for the CBB intention. The CBB describes a mutual agreement about treatments, not necessarily the direct actions or policy for treatments. The latter would be more fitting in the CarePlan resource. Future migration to a higher version of FHIR or the CBB will result in the reevaluation of the mapping.
| |
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
|
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 DefinitionThe comment may include further information such as the reason why a treatment directive has been drawn up, persons who assisted the patient in agreeing the treatment directive but who are not otherwise involved in the agreement as a representative, etc.
| ||
valueString | string | There are no (further) constraints on this element Data Type | ||
additionalAdvanceDirective | I | 0..* | Extension(Reference(HdBe AdvanceDirective)) | Element IdConsent.extension:additionalAdvanceDirective Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. The cardinality of the Extension(Reference(HdBe AdvanceDirective)) Extension URLhttps://fhir.healthdata.be/StructureDefinition/ext-TreatmentDirective2.AdvanceDirective Constraints
|
url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdConsent.extension:additionalAdvanceDirective.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-TreatmentDirective2.AdvanceDirective
| |
value[x] | I | 0..1 | Element IdConsent.extension:additionalAdvanceDirective.value[x] AdvanceDirective Alternate namesWilsverklaring DefinitionA (written) statement in which a person indicates wishes concerning future medical action, in the event that this person is at that point no longer (deemed) capable of taking decisions on the matter.
| |
valueReference | Reference(HdBe AdvanceDirective) | There are no (further) constraints on this element Data Type | ||
modifierExtension | ?! I | 0..* | Extension | Element IdConsent.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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
|
specificationOther | ?! I | 0..1 | Extension(string) | Element IdConsent.modifierExtension:specificationOther Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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-TreatmentDirective2.SpecificationOther Constraints
|
url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdConsent.modifierExtension:specificationOther.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-TreatmentDirective2.SpecificationOther
| |
value[x] | I | 0..1 | Element IdConsent.modifierExtension:specificationOther.value[x] SpecificationOther Alternate namesSpecificatieAnders DefinitionSpecification of the treatment decision when the decision is 'Other'.
| |
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 is implicitly mapped to the concepts MostRecentReviewDate and DateExpired. Unless the status is explicitly recorded, the following guidance applies:
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. 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. The four anticipated uses for the Consent Resource. ConsentScopeCodes (extensible)Constraints
{ "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/consentscope", "code": "treatment" } ] }
|
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://snomed.info/sct", "code": "129125009" } ] }
|
patient | Σ I | 0..1 | Reference(Patient | HdBe Patient) | 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. Reference(Patient | HdBe Patient) Constraints
|
dateTime | Σ | 0..1 | dateTime | Element IdConsent.dateTime MostRecentReviewDate Alternate namesMeestRecenteBespreekdatum DefinitionThe date on which the treatment directive has been agreed is with the patient and / or his representative (s). This can be the first time that the treatment directive have been discussed, but an existing treatment directive may also have been discussed again. The content of the treatment directive may have changed or remained the same. 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] | Σ I | 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
| |
sourceAttachment | Attachment | There are no (further) constraints on this element Data Type | ||
sourceReference | Σ I | 0..1 | Reference(Consent | DocumentReference | Contract | QuestionnaireResponse | HdBe AdvanceDirective) | Element IdConsent.source[x]:sourceReference AdvanceDirective Alternate namesWilsverklaring DefinitionA (written) statement in which a person indicates wishes concerning future medical action, in the event that this person is at that point no longer (deemed) capable of taking decisions on the matter. 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. Reference(Consent | DocumentReference | Contract | QuestionnaireResponse | HdBe AdvanceDirective) Constraints
|
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.
|
extension | I | 0..* | Extension | Element IdConsent.provision.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 element. 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
|
reasonForEnding | I | 0..1 | Extension(string) | Element IdConsent.provision.extension:reasonForEnding 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-TreatmentDirective2.ReasonForEnding Constraints
|
url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdConsent.provision.extension:reasonForEnding.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-TreatmentDirective2.ReasonForEnding
| |
value[x] | 0..1 | Element IdConsent.provision.extension:reasonForEnding.value[x] ReasonForEnding Alternate namesRedenBeeindigd DefinitionReason why the agreement on a treatment directive no longer applies.
| ||
valueString | string | There are no (further) constraints on this element Data Type | ||
type | Σ I | 0..1 | codeBinding | Element IdConsent.provision.type TreatmentDecision Alternate namesBehandelBesluit DefinitionThe joint decision taken with regard to the desirability of performing the indicated treatment. If the agreement is 'Other', 'Specification Other' shall contain the instructions for whether or not to carry out the treatment. Implementers SHALL support the SpecificationOther extension on Note that FHIR strings SHALL NOT exceed 1MB in size Use ConceptMap 'TreatmentDecision-to-ConsentProvisionType' to translate zib terminology to profile terminology in ValueSet 'ConsentProvisionType' ConsentProvisionType (required)Permitted Values TreatmentDecision_to_ConsentProvisionType 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.
|
start | Σ I | 0..1 | dateTime | There are no (further) constraints on this element Element IdConsent.provision.period.start Starting time with inclusive boundary DefinitionThe start of the period. The boundary is inclusive. If the low element is missing, the meaning is that the low boundary is not known.
|
end | Σ I | 0..1 | dateTime | Element IdConsent.provision.period.end DateExpired Alternate namesDatumBeeindigd DefinitionThe date on which the treatment directive has been withdrawn and therefore no longer applies. An explicit decision must be taken about the 'date expired', in consultation between the responsible care provider and the patient or his representative(s).Any future termination can only be entered as a condition. Often this will be linked to 1 or more events. The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.
|
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
|
agreementParty | 0..* | BackboneElement | Element IdConsent.provision.actor:agreementParty AgreementParty Alternate namesAfspraakPartij DefinitionContainer of the Agreement concept.This container contains all data elements of the Agreement concept.
| |
role | 1..1 | CodeableConceptBinding | Element IdConsent.provision.actor:agreementParty.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": "CONSENTER" } ] }
| |
reference | I | 1..1 | pattern HealthProfessional Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole | HdBe Patient | HdBe ContactPerson | HdBe HealthProfessional PractitionerRole) | Element IdConsent.provision.actor:agreementParty.reference Patient / Representative / HealthProfessional Alternate namesPatient, Vertegenwoordiger, Zorgverlener Definition
Each occurrence of the CBB HealthProfessional is normally represented by two FHIR resources: a PractitionerRole resource (instance of HdBe-HealthProfessional-PractitionerRole) and a Practitioner resource (instance of HdBe-HealthProfessional-Practitioner). The Practitioner resource is referenced from the PractitionerRole instance. For this reason, sending systems should fill the reference to the PractitionerRole instance here, and not the Practitioner resource. Receiving systems can then retrieve the reference to the Practitioner resource from that PractitionerRole instance. In rare circumstances, there is only a Practitioner instance, in which case it is that instance which will be referenced here. However, since this should be the exception, the HdBe-HealthProfessional-Practitioner profile is not explicitly mentioned as a target profile. pattern HealthProfessional Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole | HdBe Patient | HdBe ContactPerson | HdBe HealthProfessional PractitionerRole) 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 Treatment Alternate namesBehandeling DefinitionThe medical treatment to which the treatment instruction applies. Typical use of this is a Document code with class = CDA. If this code is found in an instance, then the exception applies. Treatment (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 | comment |
---|---|---|---|
Consent | TreatmentDirective | HdBe-TreatmentDirective2 | |
Consent.extension:comment.value[x] | TreatmentDirective.Comment | HdBe-TreatmentDirective2 | |
Consent.extension:additionalAdvanceDirective.value[x] | TreatmentDirective.AdvanceDirective | HdBe-TreatmentDirective2 | |
Consent.modifierExtension:specificationOther.value[x] | TreatmentDirective.SpecificationOther | HdBe-TreatmentDirective2 | |
Consent.status | TreatmentDirective.MostRecentReviewDate | HdBe-TreatmentDirective2 | MostRecentReviewDate (implicit, main mapping is on `Consent.dateTime`) |
Consent.status | TreatmentDirective.DateExpired | HdBe-TreatmentDirective2 | DateExpired (implicit, main mapping is on `Consent.provision.period.end`) |
Consent.dateTime | TreatmentDirective.MostRecentReviewDate | HdBe-TreatmentDirective2 | |
Consent.source[x]:sourceReference | TreatmentDirective.AdvanceDirective | HdBe-TreatmentDirective2 | |
Consent.provision.extension:reasonForEnding.value[x] | TreatmentDirective.ReasonForEnding | HdBe-TreatmentDirective2 | |
Consent.provision.type | TreatmentDirective.TreatmentDecision | HdBe-TreatmentDirective2 | |
Consent.provision.period.end | TreatmentDirective.DateExpired | HdBe-TreatmentDirective2 | |
Consent.provision.actor:agreementParty | TreatmentDirective.AgreementParty | HdBe-TreatmentDirective2 | |
Consent.provision.actor:agreementParty.reference | TreatmentDirective.AgreementParty.Patient | HdBe-TreatmentDirective2 | |
Consent.provision.actor:agreementParty.reference | TreatmentDirective.AgreementParty.Representative | HdBe-TreatmentDirective2 | |
Consent.provision.actor:agreementParty.reference | TreatmentDirective.AgreementParty.HealthProfessional | HdBe-TreatmentDirective2 | |
Consent.provision.code | TreatmentDirective.Treatment | HdBe-TreatmentDirective2 |
zib-TreatmentDirective2 difference
Concept | Category | Description |
---|---|---|
Consent.provision.code |
terminology | Changed binding strenght from Required to Extensible because it is very likely other codes may be relevant in the future. This is already the case with the zibs in release 2020 versus the pre-release of 2022 where new codes have been added. |
Consent.provision.type |
terminology | Changed ValueSet and related ConceptMap to have SNOMED codes instead of zib internal codes. |
Consent.policy.uri |
textual | Replaced Dutch context in the guidance on how to populate the policy. Instead of a suggestion for wetten.overheid.nl the URL https://www.belgielex.be/ is now given. |
Terminology Bindings
Path | Name | Strength | URL | ConceptMap |
---|---|---|---|---|
Consent.provision.type | consent-provision-type|4.0.1 | required | http://hl7.org/fhir/ValueSet/consent-provision-type|4.0.1 | https://fhir.healthdata.be/ConceptMap/TreatmentDecision-to-ConsentProvisionType |
Consent.provision.code | Treatment | extensible | https://fhir.healthdata.be/ValueSet/Treatment | No bound ConceptMap |