Important: This is a draft IG for trial use. Click here to give feedback.

HdBe-MedicationContraIndication

WARNING This page contains a draft CBB, as raw output from the zib export and automatic conversion to CBB. It requires thorough review and adaption to the Belgian realm. This CBB is merely added for informative use.

CBB	Description	Status
HdBe-MedicationContraIndication	A contra-indication (CI) for medication safety is a condition or characteristic of a patient where healthcare professionals are not allowed to subscribe certain medicines, or only under certain conditions. Purpose Contraindications should be taken into account with drug treatement. These are important for medication safety monitoring. Evidence Base A number of contraindications for medication safety are disorders that are also recorded as a problem (HCIM Problem) and/or as a warning (HCIM Alert) and not only as a medication contraindication . In the Netherlands it is important to also capture these via the G standard (thesaurus 40) as a contra-indication. Contraindications are used for medication safety. Through its use in these applications, important warnings / signals are given to healthcare professionals. Instructions In the G-standard Thesaurus 40, Z-Index uses 2 terms. The contraindication nature: the list of items referred to from MedicationContraIndicationName) and the contraindication: the combination of recorded contraindication nature + the medicine (the contraindication codes from file 655). This last combination between contraindication nature and medication is made via this MedicationContraIndication HCIM and one or more of the other medication HCIMs. For example in a medication process use-case ePrescription and/or dispense of medication.	draft

CBB

Description

Status

HdBe-MedicationContraIndication

A contra-indication (CI) for medication safety is a condition or characteristic of a patient where healthcare professionals are not allowed to subscribe certain medicines, or only under certain conditions.

Purpose

Contraindications should be taken into account with drug treatement. These are important for medication safety monitoring.

Evidence Base

A number of contraindications for medication safety are disorders that are also recorded as a problem (HCIM Problem) and/or as a warning (HCIM Alert) and not only as a medication contraindication . In the Netherlands it is important to also capture these via the G standard (thesaurus 40) as a contra-indication. Contraindications are used for medication safety. Through its use in these applications, important warnings / signals are given to healthcare professionals.

Instructions

In the G-standard Thesaurus 40, Z-Index uses 2 terms.

The contraindication nature: the list of items referred to from MedicationContraIndicationName) and
the contraindication: the combination of recorded contraindication nature + the medicine (the contraindication codes from file 655).

This last combination between contraindication nature and medication is made via this MedicationContraIndication HCIM and one or more of the other medication HCIMs. For example in a medication process use-case ePrescription and/or dispense of medication.

draft

MedicationContraIndication			MedicationContraIndication	Element id MedicationContraIndication Short description MedicationContraIndication Definition Root concept of the MedicationContraIndication information model.This root concept contains all data elements of the MedicationContraIndication information model. Data type MedicationContraIndication Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
id		0..1	string	There are no (further) constraints on this element Element id MedicationContraIndication.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id MedicationContraIndication.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May 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. Comments 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
StartDate		0..1	dateTime	Element id MedicationContraIndication.StartDate Short description StartDate Definition The date and possibly time when the contra-indication for medication was identified. Data type dateTime Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
EndDate		0..1	dateTime	Element id MedicationContraIndication.EndDate Short description EndDate Definition The date and, if applicable, time when the contraindication for medication monitoring is considered no longer applicable. Data type dateTime Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
ReasonClosure		0..1	string	Element id MedicationContraIndication.ReasonClosure Short description ReasonClosure Definition Reason for closing the medication contraindication. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
Reporter	I	1..1	Reference(HdBe-HealthProfessional)	Element id MedicationContraIndication.Reporter Short description Reporter Definition The healthcare professional who takes responsibility for registering the contraindication Comments 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. Data type Reference(HdBe-HealthProfessional) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
MedicationContraIndicationName		1..1	CodeableConceptBinding	Element id MedicationContraIndication.MedicationContraIndicationName Short description MedicationContraIndicationName Definition The name and code of the contraindication from the Dutch National Contra-indication list (G-standard Thesaurus 40). Comments 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. Data type CodeableConcept Binding MedicationContraIndicationName codes MedicationContraIndicationName (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
Comment		0..1	string	Element id MedicationContraIndication.Comment Short description Comment Definition Comment on the contraindication important for interpretation which cannot be captured in any of the other data items. For example, a comment on a contraindication with an end date in the future. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a

MedicationContraIndication		0..*
MedicationContraIndication.StartDate	dateTime	0..1
MedicationContraIndication.EndDate	dateTime	0..1
MedicationContraIndication.ReasonClosure	string	0..1
MedicationContraIndication.Reporter	Reference(HdBe-HealthProfessional)	1..1
MedicationContraIndication.MedicationContraIndicationName	CodeableConcept	1..1
MedicationContraIndication.Comment	string	0..1

MedicationContraIndication
Definition	Root concept of the MedicationContraIndication information model.This root concept contains all data elements of the MedicationContraIndication information model.
Cardinality	0...*
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a
MedicationContraIndication.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0...1
Type	string
Mappings	rim: n/a
MedicationContraIndication.extension
Definition	May 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.
Cardinality	0...*
Type	Extension
Alias	extensions, user content
Comments	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.
Slicing	Unordered, Open, by url(Value)
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: n/a rim: N/A
MedicationContraIndication.StartDate
Definition	The date and possibly time when the contra-indication for medication was identified.
Cardinality	0...1
Type	dateTime
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a
MedicationContraIndication.EndDate
Definition	The date and, if applicable, time when the contraindication for medication monitoring is considered no longer applicable.
Cardinality	0...1
Type	dateTime
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a
MedicationContraIndication.ReasonClosure
Definition	Reason for closing the medication contraindication.
Cardinality	0...1
Type	string
Comments	Note that FHIR strings SHALL NOT exceed 1MB in size
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a
MedicationContraIndication.Reporter
Definition	The healthcare professional who takes responsibility for registering the contraindication
Cardinality	1...1
Type	Reference(HdBe-HealthProfessional)
Comments	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.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))`
Mappings	rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
MedicationContraIndication.MedicationContraIndicationName
Definition	The name and code of the contraindication from the Dutch National Contra-indication list (G-standard Thesaurus 40).
Cardinality	1...1
Type	CodeableConcept
Binding	MedicationContraIndicationName codes MedicationContraIndicationName (required)
Comments	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.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
MedicationContraIndication.Comment
Definition	Comment on the contraindication important for interpretation which cannot be captured in any of the other data items. For example, a comment on a contraindication with an end date in the future.
Cardinality	0...1
Type	string
Comments	Note that FHIR strings SHALL NOT exceed 1MB in size
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a

Example instances

[CBB name]
[Concept name ]	[example value]

// example of NameInformation

## Example instances

| NameInformation      |                   |
|----------------------|-------------------|
| FirstNames | Johanna Petronella Maria   
| Initials | J.P.M. 
| GivenName | Jo 
| NameUsage | Geslachtsnaam partner gevolgd door eigen geslachtsnaam
| LastName.Prefix | van
| LastName.LastName | Putten
| LastNamePartner.PartnerPrefix | van der
| LastNamePartner.PartnerLastName | Giessen
| Titles |

zib [zib name + version](https://zibs.nl/wiki/[zib name + version(release)]) difference

Concept	Category	Description
`[element.path]`	[category of change]	[Description of change]([Reference to ticket/issue/zulip chat using MarkDown link])

Terminology Bindings

Path	Name	Strength	URL
MedicationContraIndicationName	MedicationContraIndicationName	required	https://fhir.healthdata.be/ValueSet/MedicationContraIndicationName