Medication
1.1.0 - STU Belgium flag

Medication, published by HL7 Belgium. This guide is not an authorized publication; it is the continuous build for version 1.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-be/medication/ and changes regularly. See the Directory of published versions

Logical Model: KMEHR Medication Schema v5.8

Official URL: https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/KMEHRMS Version: 1.1.0
Draft as of 2024-04-16 Computable Name: KMEHRMS

This model represents the Medication Schema KMEHR V5.8. It is shown for demonstrating the field correspondence/equivalence, and not to imply any intended scope or intended behaviour.

Thís model reflects some key aspects of the KMEHR Medication Schema structure and their use. It is not an authoritative source. It is just represented here as information, reflecting the discussions about a possible correspondence for mapping between KMEHR and FHIR. For a full documentation - technical or functional - of the Medication Schema in KMEHR, users should refer to the eHealth platform documentation.

Usage:

  • This Logical Model Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. KMEHRMS 0..* Base KMEHR Medication Schema v5.8
Instances of this logical model are not marked to be the target of a Reference
... KMEHRMessage 1..1 Class KMEHR Message
.... header 1..1 Class KMEHR Message header
..... standard 1..1 Class Which version of the standard is used
...... cd 1..1 CD The version of the KMEHR standard used
..... date 0..1 date Date
..... time 0..1 time Time
..... sender 0..1 Class Sender
...... hcpartyHub 0..1 Class the identifier of the hub
....... itemId 1..1 string the hub identifier
Example Example: 1990001916
....... cd 1..1 code the type of the hcparty
....... name 0..1 string the name of the hub
...... hcpartyOrg 0..1 Class the identifier of the org
....... itemId 0..1 string the org identifier - NIHDII number of the org
Example Example: 1990001916
....... cd 1..1 code the type of the hcparty
....... idencryptionActor 0..1 integer to be checked: usage & cardinality
....... idencryptionApplication 0..1 ANY Application
....... cdencryptionActor 0..1 Class Usage & cardinality
....... name 0..1 string The name of the org
...... hcpartyindividual 1..1 Class the identifier of the individual
....... idriziv 0..1 string the RIZIV individual identifier
....... idinss 0..1 string the Belgian Social Security Number identifier
Example Example: 69060733632
....... idencryptionActor 0..1 integer to be checked: usage & cardinality
....... cd 1..1 code the type of the hcparty
Example Example: persphysician
....... cdencryptionActor 0..1 Class to be checked: usage & cardinality
....... firstname 0..1 string the first name of the individual
....... familyname 0..1 string the last name of the individual
Example Example: Hendrix
....... address 0..* Class Home, work, ... address(es) of the patient or healthcare party.
........ cd 1..1 Class Coded value
........ nis 0..1 code explanation: https://nl.wikipedia.org/wiki/NIS-code
Example Example: 24062
....... telecom 0..* string Fax, phone, … number(s) of the healthcare party.
...... hcpartyapplication 0..1 Class the software identifier
....... itemId 0..1 string the software identifier
....... cd 1..1 code the type of the hcparty
....... name 0..1 string The name of the application.
..... recipient 0..1 Class Recipient
...... hcpartyHub 0..1 Class the identifier of the hub
....... itemId 1..1 string the hub identifier
Example Example: 1990001916
....... cd 1..1 code the type of the hcparty
....... name 0..1 string the name of the hub
...... hcpartyOrg 0..1 Class the identifier of the org
....... itemId 0..1 string the org identifier - NIHDII number of the org
Example Example: 1990001916
....... cd 1..1 code the type of the hcparty
....... idencryptionActor 0..1 integer to be checked: usage & cardinality
....... idencryptionApplication 0..1 ANY Application
....... cdencryptionActor 0..1 Class Usage & cardinality
....... name 0..1 string The name of the org
...... hcpartyindividual 1..1 Class the identifier of the individual
....... idriziv 0..1 string the RIZIV individual identifier
....... idinss 0..1 string the Belgian Social Security Number identifier
Example Example: 69060733632
....... idencryptionActor 0..1 integer to be checked: usage & cardinality
....... cd 1..1 code the type of the hcparty
Example Example: persphysician
....... cdencryptionActor 0..1 Class to be checked: usage & cardinality
....... firstname 0..1 string the first name of the individual
....... familyname 0..1 string the last name of the individual
Example Example: Hendrix
....... address 0..* Class Home, work, ... address(es) of the patient or healthcare party.
........ cd 1..1 Class Coded value
........ nis 0..1 code explanation: https://nl.wikipedia.org/wiki/NIS-code
Example Example: 24062
....... telecom 0..* string Fax, phone, … number(s) of the healthcare party.
...... hcpartyapplication 0..1 Class the software identifier
....... itemId 0..1 string the software identifier
....... cd 1..1 code the type of the hcparty
....... name 0..1 string The name of the application.
.... folder 1..1 Class The only data that matters
..... idkmehr 1..1 integer ID-KMEHR
..... patient 1..1 Class the patient
...... idinss 0..1 string the Belgian Social Security Number identifier
...... firstname 0..1 string First name of the patient. If no first name exists, the element will be empty.
...... familyname 0..1 string Family name of the patient
...... birthdate 0..1 date Birth date of the patient (uses the basic data types for dates)
...... deathdate 0..1 date this is not used
...... sex 1..1 Class Sex of the patient
....... cd 1..1 code Coded value of patient sex
...... address 0..1 Class Home, work, … address(es) of the patient.
....... cd 1..1 code Coded value
....... zip 0..1 integer Zip-code of the city
....... city 0..1 string The name of the city
....... street 0..1 string The name of the street
....... housenumber 0..1 string Housenumber within the street
...... nationality 0..1 string Nationality of the patient. Initially, the use of the CD-COUNTRY dictionary was required. We now recommend the use of the CD-FED-COUNTRY dictionary.
....... cd 1..1 code Coded value
...... usuallanguage 0..1 string Usual language of the patient using the W3C language codes.
...... telecom 0..1 string Fax, phone, … number(s) of the patient.
...... recorddatetime 0..1 ANY Date of recording of the patient data.
...... text 0..1 string Comment about the patient.
..... MSTransaction 1..1 Class The metadata for the message
...... idothers 0..* integer Local ID of the medication line
...... cd 1..1 code code
...... date 1..1 date The date when the line was registered in the schema
...... time 1..1 date The time when the line was registered in the schema
...... author 1..1 Class The author of the line in the schema
....... hcpartyHub 0..1 Class the identifier of the hub
........ itemId 1..1 string the hub identifier
Example Example: 1990001916
........ cd 1..1 code the type of the hcparty
........ name 0..1 string the name of the hub
....... hcpartyOrg 0..1 Class the identifier of the org
........ itemId 0..1 string the org identifier - NIHDII number of the org
Example Example: 1990001916
........ cd 1..1 code the type of the hcparty
........ idencryptionActor 0..1 integer to be checked: usage & cardinality
........ idencryptionApplication 0..1 ANY Application
........ cdencryptionActor 0..1 Class Usage & cardinality
........ name 0..1 string The name of the org
....... hcpartyindividual 1..1 Class the identifier of the individual
........ idriziv 0..1 string the RIZIV individual identifier
........ idinss 0..1 string the Belgian Social Security Number identifier
Example Example: 69060733632
........ idencryptionActor 0..1 integer to be checked: usage & cardinality
........ cd 1..1 code the type of the hcparty
Example Example: persphysician
........ cdencryptionActor 0..1 Class to be checked: usage & cardinality
........ firstname 0..1 string the first name of the individual
........ familyname 0..1 string the last name of the individual
Example Example: Hendrix
........ address 0..* Class Home, work, ... address(es) of the patient or healthcare party.
......... cd 1..1 Class Coded value
......... nis 0..1 code explanation: https://nl.wikipedia.org/wiki/NIS-code
Example Example: 24062
........ telecom 0..* string Fax, phone, … number(s) of the healthcare party.
....... hcpartyapplication 0..1 Class the software identifier
........ itemId 0..1 string the software identifier
........ cd 1..1 code the type of the hcparty
........ name 0..1 string The name of the application.
...... isComplete 1..1 boolean is complete
...... isValidated 1..1 boolean is validated
...... version 0..1 integer version of the medication scheme
..... MSETransactionTreatmentSuspension 0..* Class The treatment suspension line(s)
...... idkmehr 1..1 integer the KMEHR identifier for the medication line
...... idother 0..* string Local ID of the medication line
...... cd 0..* code Coded value
...... date 1..1 date The date when the line was registered in the schema
...... time 1..1 date The time when the line was registered in the schema
...... author 1..1 Class The author of the line in the schema
....... hcpartyHub 0..1 Class the identifier of the hub
........ itemId 1..1 string the hub identifier
Example Example: 1990001916
........ cd 1..1 code the type of the hcparty
........ name 0..1 string the name of the hub
....... hcpartyOrg 0..1 Class the identifier of the org
........ itemId 0..1 string the org identifier - NIHDII number of the org
Example Example: 1990001916
........ cd 1..1 code the type of the hcparty
........ idencryptionActor 0..1 integer to be checked: usage & cardinality
........ idencryptionApplication 0..1 ANY Application
........ cdencryptionActor 0..1 Class Usage & cardinality
........ name 0..1 string The name of the org
....... hcpartyindividual 1..1 Class the identifier of the individual
........ idriziv 0..1 string the RIZIV individual identifier
........ idinss 0..1 string the Belgian Social Security Number identifier
Example Example: 69060733632
........ idencryptionActor 0..1 integer to be checked: usage & cardinality
........ cd 1..1 code the type of the hcparty
Example Example: persphysician
........ cdencryptionActor 0..1 Class to be checked: usage & cardinality
........ firstname 0..1 string the first name of the individual
........ familyname 0..1 string the last name of the individual
Example Example: Hendrix
........ address 0..* Class Home, work, ... address(es) of the patient or healthcare party.
......... cd 1..1 Class Coded value
......... nis 0..1 code explanation: https://nl.wikipedia.org/wiki/NIS-code
Example Example: 24062
........ telecom 0..* string Fax, phone, … number(s) of the healthcare party.
....... hcpartyapplication 0..1 Class the software identifier
........ itemId 0..1 string the software identifier
........ cd 1..1 code the type of the hcparty
........ name 0..1 string The name of the application.
...... isComplete 1..1 boolean is complete
...... isValidated 1..1 boolean is validated
...... itemmedication 0..* Class This describes the medication it is linked to, but has no further relevance
....... itemId 0..* integer a sequential unique item ID within the transaction, start=1
....... cd 0..* ANY describes the item category
....... beginMoment 1..1 Class The beginmoment of the medication/treatment suspension
........ date 1..1 date Date
........ time 0..1 time Time
....... endMoment 0..1 Class the end date (and time) of the suspension
........ date 1..1 date Date
........ time 0..1 time Time
....... content 0..* Class To Do
........ medicinalproduct 0..* Class Description of the medicinal product
......... intendedName 0..1 ST Name of prescribed product
......... intendedCd 0..1 CD CD-DRUG-CNK + Code (CNK)
......... deliveredName 0..1 ST Name of delivered product
......... deliveredCd 0..1 CD CD-DRUG-CNK + Code (CNK)
........ substanceproduct 0..* Class Description of the generic product
......... intendedName 0..1 ST Name of prescribed product
Example Example: chloorfenamine + paracetamol oraal 3,2 mg + 240 mg
......... intendedCd 0..1 CD Code of prescribed product (VMPGROUP or CNK)
......... deliveredName 0..1 ST Name of delivered product
......... deliveredCd 0..1 CD Code of delivered product (CNK)
........ compoundprescription 0..* Class Description of the compound product
......... magistraltext 1..1 ST Recipe of the prescription
Example Example: R/ Aluminiumchloride hexahydraat 15 g + Isopropylalcohol 78 g + Gezuiverd water q.s. ad 100 g T
......... compound 0..0
......... formularyReference 0..0
....... text 0..* string Mandatory if compoundprescription is used - !!to be checked if possible in TS transaction!!
....... lifecycle 1..1 string The indication of the status, only used in a TS with value 'suspended'
....... lnk 1..1 string using a link to the transaction (in the current MedicationSchema) of the related medicine
...... itemtransactionreason 0..1 Class Extra information on the reason of suspention of the linked medication
....... itemId 0..* integer a sequential unique item ID within the transaction, start=1
....... cd 0..* ANY describes the item category
....... contenttext 0..* Class Text
........ text 1..* string cardinality to be checked

Example Example: Temporairement ne pas prendre en raison de l'interaction avec Y.
..... MSETransactionmedication 0..* Class The medication lines
...... idkmehr 1..1 integer the KMEHR identifier for the medication line
...... idother 0..* string Local ID of the medication line
...... cd 0..* code Coded value
...... date 1..1 date The date when the line was registered in the schema
...... time 1..1 date The time when the line was registered in the schema
...... author 1..1 Class The author of the line in the schema
....... hcpartyHub 0..1 Class the identifier of the hub
........ itemId 1..1 string the hub identifier
Example Example: 1990001916
........ cd 1..1 code the type of the hcparty
........ name 0..1 string the name of the hub
....... hcpartyOrg 0..1 Class the identifier of the org
........ itemId 0..1 string the org identifier - NIHDII number of the org
Example Example: 1990001916
........ cd 1..1 code the type of the hcparty
........ idencryptionActor 0..1 integer to be checked: usage & cardinality
........ idencryptionApplication 0..1 ANY Application
........ cdencryptionActor 0..1 Class Usage & cardinality
........ name 0..1 string The name of the org
....... hcpartyindividual 1..1 Class the identifier of the individual
........ idriziv 0..1 string the RIZIV individual identifier
........ idinss 0..1 string the Belgian Social Security Number identifier
Example Example: 69060733632
........ idencryptionActor 0..1 integer to be checked: usage & cardinality
........ cd 1..1 code the type of the hcparty
Example Example: persphysician
........ cdencryptionActor 0..1 Class to be checked: usage & cardinality
........ firstname 0..1 string the first name of the individual
........ familyname 0..1 string the last name of the individual
Example Example: Hendrix
........ address 0..* Class Home, work, ... address(es) of the patient or healthcare party.
......... cd 1..1 Class Coded value
......... nis 0..1 code explanation: https://nl.wikipedia.org/wiki/NIS-code
Example Example: 24062
........ telecom 0..* string Fax, phone, … number(s) of the healthcare party.
....... hcpartyapplication 0..1 Class the software identifier
........ itemId 0..1 string the software identifier
........ cd 1..1 code the type of the hcparty
........ name 0..1 string The name of the application.
...... isComplete 1..1 boolean is complete
...... isValidated 1..1 boolean is validated
...... version 0..* string TO DO
...... itemmedicationUse 0..1 Class Extra information on the usage of the medication within this transaction
....... itemId 0..* integer a sequential unique item ID within the transaction, start=1
....... cd 0..* ANY describes the item category
....... contentcategory 1..* Class Category
........ cd 0..* Class Coded value
....... contenttext 0..* Class Text
........ text 1..* string cardinality to be checked

Example Example: pression artérielle
...... itemendCondition 0..1 Class Extra information on the endcondition of the medication within this MSE-transaction
....... itemId 0..* integer a sequential unique item ID within the transaction, start=1
....... cd 0..* ANY describes the item category
....... contentcategory 1..* Class Category
........ cd 0..* Class Coded value
....... contenttext 0..* Class Text
........ text 1..* string cardinality to be checked

Example Example: pression artérielle
...... itembeginCondition 0..1 Class Extra information on the begincondition of the medication within this MSE-transaction
....... itemId 0..* integer a sequential unique item ID within the transaction, start=1
....... cd 0..* ANY describes the item category
....... contentcategory 1..* Class Category
........ cd 0..* Class Coded value
....... contenttext 0..* Class Text
........ text 1..* string cardinality to be checked

Example Example: pression artérielle
...... itemorigin 0..0
...... itemmedicationType 0..0
...... itemadaptationFlag 0..0
...... itemmedication 0..* Class To Do
....... itemId 0..* integer a sequential unique item ID within the transaction, start=1
....... cd 0..* ANY describes the item category
....... beginMoment 1..1 Class The beginmoment of the medication/treatment suspension
........ date 1..1 date Date
........ time 0..1 time Time
....... endMoment 0..1 Class The end moment of the medication/treatment suspension
........ date 1..1 date Date
........ time 0..1 time Time
....... duration 0..1 integer The duration of the treatment
....... contentmedicationIdentification 0..* Class To Do
........ medicinalproduct 0..* Class Description of the medicinal product
......... intendedName 0..1 ST Name of prescribed product
......... intendedCd 0..1 CD CD-DRUG-CNK + Code (CNK)
......... deliveredName 0..1 ST Name of delivered product
......... deliveredCd 0..1 CD CD-DRUG-CNK + Code (CNK)
........ substanceproduct 0..* Class Description of the generic product
......... intendedName 0..1 ST Name of prescribed product
Example Example: chloorfenamine + paracetamol oraal 3,2 mg + 240 mg
......... intendedCd 0..1 CD Code of prescribed product (VMPGROUP or CNK)
......... deliveredName 0..1 ST Name of delivered product
......... deliveredCd 0..1 CD Code of delivered product (CNK)
........ compoundprescription 0..* Class Description of the compound product
......... magistraltext 1..1 ST Recipe of the prescription
Example Example: R/ Aluminiumchloride hexahydraat 15 g + Isopropylalcohol 78 g + Gezuiverd water q.s. ad 100 g T
......... compound 0..0
......... formularyReference 0..0
....... content 0..* string Extra content field which can be added if neccessary
....... text 0..* string Mandatory if compoundprescription is used

Example Example: Aluminiumchloride transpiratieremmende hydroalcoholische oplossing 15 % TMF
....... temporality 0..* Class The temporality
........ cd 0..1 string Coded value
....... frequency 0..* Class To Do
........ periodicity 0..* Class To Do
......... cd 0..* ANY S-VALUE=CD-PERIODICITY
....... posology 0..* Class The freetext posology is mutual exclusive with the structured Regimen
........ text 1..1 string Contains the ingestion pattern in textual form
Example Example: tot 4 x per dag 1 tablet
........ low 0..0
........ high 0..0
........ unit 0..0
........ takes 0..0
....... regimen 0..* Class To Do
........ date 0..* date date, mostly used icw periodicity=monthly or at a specifiec time of the day
........ weekday 0..* integer Day of the week, mostly used icw periodicity=weekly
......... cd 1..1 string the day of the week
Example Example: monday
........ daynumber 0..* integer Daynumber, mostly used icw periodicity=weekly or daily
........ daytime 0..* Class indication of the intake moment
......... time 1..1 date The time when the line was registered in the schema
......... dayperiod 1..* Class mutual exclusive with <time>
.......... cd 0..* string Coded value
........ quantity 1..1 Class To Do
......... decimal 0..* integer the amount, expressed in a number
......... unit 0..* Class the prescribed administration unit where the decimal applies to
.......... cd 0..* string To Do
....... route 0..* Class The drug administration route
........ cd 0..* ANY To Do
....... instructionForOverDosing 0..0
....... instructionForReimbursement 0..0
....... isSubstitutionAllowed 0..0
....... feedback 0..0
....... local 0..0
....... batch 0..0
....... deliveryDate 0..0
....... instructionforpatient 0..1 string Usage instructions for the patient.
Example Example: A diminuer si possible

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. KMEHRMS 0..* Base KMEHR Medication Schema v5.8
Instances of this logical model are not marked to be the target of a Reference
... KMEHRMessage 1..1 Class KMEHR Message
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... header 1..1 Class KMEHR Message header
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... standard 1..1 Class Which version of the standard is used
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... cd 1..1 CD The version of the KMEHR standard used
..... date 0..1 date Date
..... time 0..1 time Time
..... sender 0..1 Class Sender
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... hcpartyHub 0..1 Class the identifier of the hub
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... itemId 1..1 string the hub identifier
Example Example: 1990001916
....... cd 1..1 code the type of the hcparty
....... name 0..1 string the name of the hub
...... hcpartyOrg 0..1 Class the identifier of the org
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... itemId 0..1 string the org identifier - NIHDII number of the org
Example Example: 1990001916
....... cd 1..1 code the type of the hcparty
....... idencryptionActor 0..1 integer to be checked: usage & cardinality
....... idencryptionApplication 0..1 ANY Application
....... cdencryptionActor 0..1 Class Usage & cardinality
....... name 0..1 string The name of the org
...... hcpartyindividual 1..1 Class the identifier of the individual
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... idriziv 0..1 string the RIZIV individual identifier
....... idinss 0..1 string the Belgian Social Security Number identifier
Example Example: 69060733632
....... idencryptionActor 0..1 integer to be checked: usage & cardinality
....... cd 1..1 code the type of the hcparty
Example Example: persphysician
....... cdencryptionActor 0..1 Class to be checked: usage & cardinality
....... firstname 0..1 string the first name of the individual
....... familyname 0..1 string the last name of the individual
Example Example: Hendrix
....... address 0..* Class Home, work, ... address(es) of the patient or healthcare party.
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ cd 1..1 Class Coded value
........ nis 0..1 code explanation: https://nl.wikipedia.org/wiki/NIS-code
Example Example: 24062
....... telecom 0..* string Fax, phone, … number(s) of the healthcare party.
...... hcpartyapplication 0..1 Class the software identifier
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... itemId 0..1 string the software identifier
....... cd 1..1 code the type of the hcparty
....... name 0..1 string The name of the application.
..... recipient 0..1 Class Recipient
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... hcpartyHub 0..1 Class the identifier of the hub
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... itemId 1..1 string the hub identifier
Example Example: 1990001916
....... cd 1..1 code the type of the hcparty
....... name 0..1 string the name of the hub
...... hcpartyOrg 0..1 Class the identifier of the org
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... itemId 0..1 string the org identifier - NIHDII number of the org
Example Example: 1990001916
....... cd 1..1 code the type of the hcparty
....... idencryptionActor 0..1 integer to be checked: usage & cardinality
....... idencryptionApplication 0..1 ANY Application
....... cdencryptionActor 0..1 Class Usage & cardinality
....... name 0..1 string The name of the org
...... hcpartyindividual 1..1 Class the identifier of the individual
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... idriziv 0..1 string the RIZIV individual identifier
....... idinss 0..1 string the Belgian Social Security Number identifier
Example Example: 69060733632
....... idencryptionActor 0..1 integer to be checked: usage & cardinality
....... cd 1..1 code the type of the hcparty
Example Example: persphysician
....... cdencryptionActor 0..1 Class to be checked: usage & cardinality
....... firstname 0..1 string the first name of the individual
....... familyname 0..1 string the last name of the individual
Example Example: Hendrix
....... address 0..* Class Home, work, ... address(es) of the patient or healthcare party.
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ cd 1..1 Class Coded value
........ nis 0..1 code explanation: https://nl.wikipedia.org/wiki/NIS-code
Example Example: 24062
....... telecom 0..* string Fax, phone, … number(s) of the healthcare party.
...... hcpartyapplication 0..1 Class the software identifier
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... itemId 0..1 string the software identifier
....... cd 1..1 code the type of the hcparty
....... name 0..1 string The name of the application.
.... folder 1..1 Class The only data that matters
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... idkmehr 1..1 integer ID-KMEHR
..... patient 1..1 Class the patient
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... idinss 0..1 string the Belgian Social Security Number identifier
...... firstname 0..1 string First name of the patient. If no first name exists, the element will be empty.
...... familyname 0..1 string Family name of the patient
...... birthdate 0..1 date Birth date of the patient (uses the basic data types for dates)
...... deathdate 0..1 date this is not used
...... sex 1..1 Class Sex of the patient
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... cd 1..1 code Coded value of patient sex
...... address 0..1 Class Home, work, … address(es) of the patient.
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... cd 1..1 code Coded value
....... zip 0..1 integer Zip-code of the city
....... city 0..1 string The name of the city
....... street 0..1 string The name of the street
....... housenumber 0..1 string Housenumber within the street
...... nationality 0..1 string Nationality of the patient. Initially, the use of the CD-COUNTRY dictionary was required. We now recommend the use of the CD-FED-COUNTRY dictionary.
....... cd 1..1 code Coded value
...... usuallanguage 0..1 string Usual language of the patient using the W3C language codes.
...... telecom 0..1 string Fax, phone, … number(s) of the patient.
...... recorddatetime 0..1 ANY Date of recording of the patient data.
...... text 0..1 string Comment about the patient.
..... MSTransaction 1..1 Class The metadata for the message
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... idothers 0..* integer Local ID of the medication line
...... cd 1..1 code code
...... date 1..1 date The date when the line was registered in the schema
...... time 1..1 date The time when the line was registered in the schema
...... author 1..1 Class The author of the line in the schema
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... hcpartyHub 0..1 Class the identifier of the hub
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ itemId 1..1 string the hub identifier
Example Example: 1990001916
........ cd 1..1 code the type of the hcparty
........ name 0..1 string the name of the hub
....... hcpartyOrg 0..1 Class the identifier of the org
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ itemId 0..1 string the org identifier - NIHDII number of the org
Example Example: 1990001916
........ cd 1..1 code the type of the hcparty
........ idencryptionActor 0..1 integer to be checked: usage & cardinality
........ idencryptionApplication 0..1 ANY Application
........ cdencryptionActor 0..1 Class Usage & cardinality
........ name 0..1 string The name of the org
....... hcpartyindividual 1..1 Class the identifier of the individual
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ idriziv 0..1 string the RIZIV individual identifier
........ idinss 0..1 string the Belgian Social Security Number identifier
Example Example: 69060733632
........ idencryptionActor 0..1 integer to be checked: usage & cardinality
........ cd 1..1 code the type of the hcparty
Example Example: persphysician
........ cdencryptionActor 0..1 Class to be checked: usage & cardinality
........ firstname 0..1 string the first name of the individual
........ familyname 0..1 string the last name of the individual
Example Example: Hendrix
........ address 0..* Class Home, work, ... address(es) of the patient or healthcare party.
......... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
......... cd 1..1 Class Coded value
......... nis 0..1 code explanation: https://nl.wikipedia.org/wiki/NIS-code
Example Example: 24062
........ telecom 0..* string Fax, phone, … number(s) of the healthcare party.
....... hcpartyapplication 0..1 Class the software identifier
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ itemId 0..1 string the software identifier
........ cd 1..1 code the type of the hcparty
........ name 0..1 string The name of the application.
...... isComplete 1..1 boolean is complete
...... isValidated 1..1 boolean is validated
...... version 0..1 integer version of the medication scheme
..... MSETransactionTreatmentSuspension 0..* Class The treatment suspension line(s)
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... idkmehr 1..1 integer the KMEHR identifier for the medication line
...... idother 0..* string Local ID of the medication line
...... cd 0..* code Coded value
...... date 1..1 date The date when the line was registered in the schema
...... time 1..1 date The time when the line was registered in the schema
...... author 1..1 Class The author of the line in the schema
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... hcpartyHub 0..1 Class the identifier of the hub
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ itemId 1..1 string the hub identifier
Example Example: 1990001916
........ cd 1..1 code the type of the hcparty
........ name 0..1 string the name of the hub
....... hcpartyOrg 0..1 Class the identifier of the org
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ itemId 0..1 string the org identifier - NIHDII number of the org
Example Example: 1990001916
........ cd 1..1 code the type of the hcparty
........ idencryptionActor 0..1 integer to be checked: usage & cardinality
........ idencryptionApplication 0..1 ANY Application
........ cdencryptionActor 0..1 Class Usage & cardinality
........ name 0..1 string The name of the org
....... hcpartyindividual 1..1 Class the identifier of the individual
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ idriziv 0..1 string the RIZIV individual identifier
........ idinss 0..1 string the Belgian Social Security Number identifier
Example Example: 69060733632
........ idencryptionActor 0..1 integer to be checked: usage & cardinality
........ cd 1..1 code the type of the hcparty
Example Example: persphysician
........ cdencryptionActor 0..1 Class to be checked: usage & cardinality
........ firstname 0..1 string the first name of the individual
........ familyname 0..1 string the last name of the individual
Example Example: Hendrix
........ address 0..* Class Home, work, ... address(es) of the patient or healthcare party.
......... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
......... cd 1..1 Class Coded value
......... nis 0..1 code explanation: https://nl.wikipedia.org/wiki/NIS-code
Example Example: 24062
........ telecom 0..* string Fax, phone, … number(s) of the healthcare party.
....... hcpartyapplication 0..1 Class the software identifier
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ itemId 0..1 string the software identifier
........ cd 1..1 code the type of the hcparty
........ name 0..1 string The name of the application.
...... isComplete 1..1 boolean is complete
...... isValidated 1..1 boolean is validated
...... itemmedication 0..* Class This describes the medication it is linked to, but has no further relevance
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... itemId 0..* integer a sequential unique item ID within the transaction, start=1
....... cd 0..* ANY describes the item category
....... beginMoment 1..1 Class The beginmoment of the medication/treatment suspension
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ date 1..1 date Date
........ time 0..1 time Time
....... endMoment 0..1 Class the end date (and time) of the suspension
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ date 1..1 date Date
........ time 0..1 time Time
....... content 0..* Class To Do
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ medicinalproduct 0..* Class Description of the medicinal product
......... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
......... intendedName 0..1 ST Name of prescribed product
......... intendedCd 0..1 CD CD-DRUG-CNK + Code (CNK)
......... deliveredName 0..1 ST Name of delivered product
......... deliveredCd 0..1 CD CD-DRUG-CNK + Code (CNK)
........ substanceproduct 0..* Class Description of the generic product
......... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
......... intendedName 0..1 ST Name of prescribed product
Example Example: chloorfenamine + paracetamol oraal 3,2 mg + 240 mg
......... intendedCd 0..1 CD Code of prescribed product (VMPGROUP or CNK)
......... deliveredName 0..1 ST Name of delivered product
......... deliveredCd 0..1 CD Code of delivered product (CNK)
........ compoundprescription 0..* Class Description of the compound product
......... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
......... magistraltext 1..1 ST Recipe of the prescription
Example Example: R/ Aluminiumchloride hexahydraat 15 g + Isopropylalcohol 78 g + Gezuiverd water q.s. ad 100 g T
....... text 0..* string Mandatory if compoundprescription is used - !!to be checked if possible in TS transaction!!
....... lifecycle 1..1 string The indication of the status, only used in a TS with value 'suspended'
....... lnk 1..1 string using a link to the transaction (in the current MedicationSchema) of the related medicine
...... itemtransactionreason 0..1 Class Extra information on the reason of suspention of the linked medication
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... itemId 0..* integer a sequential unique item ID within the transaction, start=1
....... cd 0..* ANY describes the item category
....... contenttext 0..* Class Text
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ text 1..* string cardinality to be checked

Example Example: Temporairement ne pas prendre en raison de l'interaction avec Y.
..... MSETransactionmedication 0..* Class The medication lines
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... idkmehr 1..1 integer the KMEHR identifier for the medication line
...... idother 0..* string Local ID of the medication line
...... cd 0..* code Coded value
...... date 1..1 date The date when the line was registered in the schema
...... time 1..1 date The time when the line was registered in the schema
...... author 1..1 Class The author of the line in the schema
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... hcpartyHub 0..1 Class the identifier of the hub
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ itemId 1..1 string the hub identifier
Example Example: 1990001916
........ cd 1..1 code the type of the hcparty
........ name 0..1 string the name of the hub
....... hcpartyOrg 0..1 Class the identifier of the org
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ itemId 0..1 string the org identifier - NIHDII number of the org
Example Example: 1990001916
........ cd 1..1 code the type of the hcparty
........ idencryptionActor 0..1 integer to be checked: usage & cardinality
........ idencryptionApplication 0..1 ANY Application
........ cdencryptionActor 0..1 Class Usage & cardinality
........ name 0..1 string The name of the org
....... hcpartyindividual 1..1 Class the identifier of the individual
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ idriziv 0..1 string the RIZIV individual identifier
........ idinss 0..1 string the Belgian Social Security Number identifier
Example Example: 69060733632
........ idencryptionActor 0..1 integer to be checked: usage & cardinality
........ cd 1..1 code the type of the hcparty
Example Example: persphysician
........ cdencryptionActor 0..1 Class to be checked: usage & cardinality
........ firstname 0..1 string the first name of the individual
........ familyname 0..1 string the last name of the individual
Example Example: Hendrix
........ address 0..* Class Home, work, ... address(es) of the patient or healthcare party.
......... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
......... cd 1..1 Class Coded value
......... nis 0..1 code explanation: https://nl.wikipedia.org/wiki/NIS-code
Example Example: 24062
........ telecom 0..* string Fax, phone, … number(s) of the healthcare party.
....... hcpartyapplication 0..1 Class the software identifier
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ itemId 0..1 string the software identifier
........ cd 1..1 code the type of the hcparty
........ name 0..1 string The name of the application.
...... isComplete 1..1 boolean is complete
...... isValidated 1..1 boolean is validated
...... version 0..* string TO DO
...... itemmedicationUse 0..1 Class Extra information on the usage of the medication within this transaction
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... itemId 0..* integer a sequential unique item ID within the transaction, start=1
....... cd 0..* ANY describes the item category
....... contentcategory 1..* Class Category
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ cd 0..* Class Coded value
....... contenttext 0..* Class Text
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ text 1..* string cardinality to be checked

Example Example: pression artérielle
...... itemendCondition 0..1 Class Extra information on the endcondition of the medication within this MSE-transaction
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... itemId 0..* integer a sequential unique item ID within the transaction, start=1
....... cd 0..* ANY describes the item category
....... contentcategory 1..* Class Category
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ cd 0..* Class Coded value
....... contenttext 0..* Class Text
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ text 1..* string cardinality to be checked

Example Example: pression artérielle
...... itembeginCondition 0..1 Class Extra information on the begincondition of the medication within this MSE-transaction
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... itemId 0..* integer a sequential unique item ID within the transaction, start=1
....... cd 0..* ANY describes the item category
....... contentcategory 1..* Class Category
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ cd 0..* Class Coded value
....... contenttext 0..* Class Text
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ text 1..* string cardinality to be checked

Example Example: pression artérielle
...... itemmedication 0..* Class To Do
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... itemId 0..* integer a sequential unique item ID within the transaction, start=1
....... cd 0..* ANY describes the item category
....... beginMoment 1..1 Class The beginmoment of the medication/treatment suspension
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ date 1..1 date Date
........ time 0..1 time Time
....... endMoment 0..1 Class The end moment of the medication/treatment suspension
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ date 1..1 date Date
........ time 0..1 time Time
....... duration 0..1 integer The duration of the treatment
....... contentmedicationIdentification 0..* Class To Do
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ medicinalproduct 0..* Class Description of the medicinal product
......... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
......... intendedName 0..1 ST Name of prescribed product
......... intendedCd 0..1 CD CD-DRUG-CNK + Code (CNK)
......... deliveredName 0..1 ST Name of delivered product
......... deliveredCd 0..1 CD CD-DRUG-CNK + Code (CNK)
........ substanceproduct 0..* Class Description of the generic product
......... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
......... intendedName 0..1 ST Name of prescribed product
Example Example: chloorfenamine + paracetamol oraal 3,2 mg + 240 mg
......... intendedCd 0..1 CD Code of prescribed product (VMPGROUP or CNK)
......... deliveredName 0..1 ST Name of delivered product
......... deliveredCd 0..1 CD Code of delivered product (CNK)
........ compoundprescription 0..* Class Description of the compound product
......... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
......... magistraltext 1..1 ST Recipe of the prescription
Example Example: R/ Aluminiumchloride hexahydraat 15 g + Isopropylalcohol 78 g + Gezuiverd water q.s. ad 100 g T
....... content 0..* string Extra content field which can be added if neccessary
....... text 0..* string Mandatory if compoundprescription is used

Example Example: Aluminiumchloride transpiratieremmende hydroalcoholische oplossing 15 % TMF
....... temporality 0..* Class The temporality
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ cd 0..1 string Coded value
....... frequency 0..* Class To Do
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ periodicity 0..* Class To Do
......... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
......... cd 0..* ANY S-VALUE=CD-PERIODICITY
....... posology 0..* Class The freetext posology is mutual exclusive with the structured Regimen
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ text 1..1 string Contains the ingestion pattern in textual form
Example Example: tot 4 x per dag 1 tablet
....... regimen 0..* Class To Do
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ date 0..* date date, mostly used icw periodicity=monthly or at a specifiec time of the day
........ weekday 0..* integer Day of the week, mostly used icw periodicity=weekly
......... cd 1..1 string the day of the week
Example Example: monday
........ daynumber 0..* integer Daynumber, mostly used icw periodicity=weekly or daily
........ daytime 0..* Class indication of the intake moment
......... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
......... time 1..1 date The time when the line was registered in the schema
......... dayperiod 1..* Class mutual exclusive with <time>
.......... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.......... cd 0..* string Coded value
........ quantity 1..1 Class To Do
......... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
......... decimal 0..* integer the amount, expressed in a number
......... unit 0..* Class the prescribed administration unit where the decimal applies to
.......... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.......... cd 0..* string To Do
....... route 0..* Class The drug administration route
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ cd 0..* ANY To Do
....... instructionforpatient 0..1 string Usage instructions for the patient.
Example Example: A diminuer si possible

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. KMEHRMS 0..* Base KMEHR Medication Schema v5.8
Instances of this logical model are not marked to be the target of a Reference
... KMEHRMessage 1..1 Class KMEHR Message
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... header 1..1 Class KMEHR Message header
..... @id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... standard 1..1 Class Which version of the standard is used
...... @id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... cd 1..1 CD The version of the KMEHR standard used
..... date 0..1 date Date
..... time 0..1 time Time
..... sender 0..1 Class Sender
...... @id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... hcpartyHub 0..1 Class the identifier of the hub
....... @id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... itemId 1..1 string the hub identifier
Example Example: 1990001916
....... cd 1..1 code the type of the hcparty
....... name 0..1 string the name of the hub
...... hcpartyOrg 0..1 Class the identifier of the org
....... @id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... itemId 0..1 string the org identifier - NIHDII number of the org
Example Example: 1990001916
....... cd 1..1 code the type of the hcparty
....... idencryptionActor 0..1 integer to be checked: usage & cardinality
....... idencryptionApplication 0..1 ANY Application
....... cdencryptionActor 0..1 Class Usage & cardinality
....... name 0..1 string The name of the org
...... hcpartyindividual 1..1 Class the identifier of the individual
....... @id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... idriziv 0..1 string the RIZIV individual identifier
....... idinss 0..1 string the Belgian Social Security Number identifier
Example Example: 69060733632
....... idencryptionActor 0..1 integer to be checked: usage & cardinality
....... cd 1..1 code the type of the hcparty
Example Example: persphysician
....... cdencryptionActor 0..1 Class to be checked: usage & cardinality
....... firstname 0..1 string the first name of the individual
....... familyname 0..1 string the last name of the individual
Example Example: Hendrix
....... address 0..* Class Home, work, ... address(es) of the patient or healthcare party.
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ cd 1..1 Class Coded value
........ nis 0..1 code explanation: https://nl.wikipedia.org/wiki/NIS-code
Example Example: 24062
....... telecom 0..* string Fax, phone, … number(s) of the healthcare party.
...... hcpartyapplication 0..1 Class the software identifier
....... @id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... itemId 0..1 string the software identifier
....... cd 1..1 code the type of the hcparty
....... name 0..1 string The name of the application.
..... recipient 0..1 Class Recipient
...... @id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... hcpartyHub 0..1 Class the identifier of the hub
....... @id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... itemId 1..1 string the hub identifier
Example Example: 1990001916
....... cd 1..1 code the type of the hcparty
....... name 0..1 string the name of the hub
...... hcpartyOrg 0..1 Class the identifier of the org
....... @id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... itemId 0..1 string the org identifier - NIHDII number of the org
Example Example: 1990001916
....... cd 1..1 code the type of the hcparty
....... idencryptionActor 0..1 integer to be checked: usage & cardinality
....... idencryptionApplication 0..1 ANY Application
....... cdencryptionActor 0..1 Class Usage & cardinality
....... name 0..1 string The name of the org
...... hcpartyindividual 1..1 Class the identifier of the individual
....... @id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... idriziv 0..1 string the RIZIV individual identifier
....... idinss 0..1 string the Belgian Social Security Number identifier
Example Example: 69060733632
....... idencryptionActor 0..1 integer to be checked: usage & cardinality
....... cd 1..1 code the type of the hcparty
Example Example: persphysician
....... cdencryptionActor 0..1 Class to be checked: usage & cardinality
....... firstname 0..1 string the first name of the individual
....... familyname 0..1 string the last name of the individual
Example Example: Hendrix
....... address 0..* Class Home, work, ... address(es) of the patient or healthcare party.
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ cd 1..1 Class Coded value
........ nis 0..1 code explanation: https://nl.wikipedia.org/wiki/NIS-code
Example Example: 24062
....... telecom 0..* string Fax, phone, … number(s) of the healthcare party.
...... hcpartyapplication 0..1 Class the software identifier
....... @id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... itemId 0..1 string the software identifier
....... cd 1..1 code the type of the hcparty
....... name 0..1 string The name of the application.
.... folder 1..1 Class The only data that matters
..... @id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... idkmehr 1..1 integer ID-KMEHR
..... patient 1..1 Class the patient
...... @id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... idinss 0..1 string the Belgian Social Security Number identifier
...... firstname 0..1 string First name of the patient. If no first name exists, the element will be empty.
...... familyname 0..1 string Family name of the patient
...... birthdate 0..1 date Birth date of the patient (uses the basic data types for dates)
...... deathdate 0..1 date this is not used
...... sex 1..1 Class Sex of the patient
....... @id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... cd 1..1 code Coded value of patient sex
...... address 0..1 Class Home, work, … address(es) of the patient.
....... @id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... cd 1..1 code Coded value
....... zip 0..1 integer Zip-code of the city
....... city 0..1 string The name of the city
....... street 0..1 string The name of the street
....... housenumber 0..1 string Housenumber within the street
...... nationality 0..1 string Nationality of the patient. Initially, the use of the CD-COUNTRY dictionary was required. We now recommend the use of the CD-FED-COUNTRY dictionary.
....... @id 0..1 string xml:id (or equivalent in JSON)
....... extension 0..* Extension Additional content defined by implementations
....... @value 0..1 string Primitive value for string
Max Length: 1048576
....... cd 1..1 code Coded value
...... usuallanguage 0..1 string Usual language of the patient using the W3C language codes.
...... telecom 0..1 string Fax, phone, … number(s) of the patient.
...... recorddatetime 0..1 ANY Date of recording of the patient data.
...... text 0..1 string Comment about the patient.
..... MSTransaction 1..1 Class The metadata for the message
...... @id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... idothers 0..* integer Local ID of the medication line
...... cd 1..1 code code
...... date 1..1 date The date when the line was registered in the schema
...... time 1..1 date The time when the line was registered in the schema
...... author 1..1 Class The author of the line in the schema
....... @id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... hcpartyHub 0..1 Class the identifier of the hub
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ itemId 1..1 string the hub identifier
Example Example: 1990001916
........ cd 1..1 code the type of the hcparty
........ name 0..1 string the name of the hub
....... hcpartyOrg 0..1 Class the identifier of the org
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ itemId 0..1 string the org identifier - NIHDII number of the org
Example Example: 1990001916
........ cd 1..1 code the type of the hcparty
........ idencryptionActor 0..1 integer to be checked: usage & cardinality
........ idencryptionApplication 0..1 ANY Application
........ cdencryptionActor 0..1 Class Usage & cardinality
........ name 0..1 string The name of the org
....... hcpartyindividual 1..1 Class the identifier of the individual
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ idriziv 0..1 string the RIZIV individual identifier
........ idinss 0..1 string the Belgian Social Security Number identifier
Example Example: 69060733632
........ idencryptionActor 0..1 integer to be checked: usage & cardinality
........ cd 1..1 code the type of the hcparty
Example Example: persphysician
........ cdencryptionActor 0..1 Class to be checked: usage & cardinality
........ firstname 0..1 string the first name of the individual
........ familyname 0..1 string the last name of the individual
Example Example: Hendrix
........ address 0..* Class Home, work, ... address(es) of the patient or healthcare party.
......... @id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
......... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
......... cd 1..1 Class Coded value
......... nis 0..1 code explanation: https://nl.wikipedia.org/wiki/NIS-code
Example Example: 24062
........ telecom 0..* string Fax, phone, … number(s) of the healthcare party.
....... hcpartyapplication 0..1 Class the software identifier
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ itemId 0..1 string the software identifier
........ cd 1..1 code the type of the hcparty
........ name 0..1 string The name of the application.
...... isComplete 1..1 boolean is complete
...... isValidated 1..1 boolean is validated
...... version 0..1 integer version of the medication scheme
..... MSETransactionTreatmentSuspension 0..* Class The treatment suspension line(s)
...... @id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... idkmehr 1..1 integer the KMEHR identifier for the medication line
...... idother 0..* string Local ID of the medication line
...... cd 0..* code Coded value
...... date 1..1 date The date when the line was registered in the schema
...... time 1..1 date The time when the line was registered in the schema
...... author 1..1 Class The author of the line in the schema
....... @id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... hcpartyHub 0..1 Class the identifier of the hub
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ itemId 1..1 string the hub identifier
Example Example: 1990001916
........ cd 1..1 code the type of the hcparty
........ name 0..1 string the name of the hub
....... hcpartyOrg 0..1 Class the identifier of the org
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ itemId 0..1 string the org identifier - NIHDII number of the org
Example Example: 1990001916
........ cd 1..1 code the type of the hcparty
........ idencryptionActor 0..1 integer to be checked: usage & cardinality
........ idencryptionApplication 0..1 ANY Application
........ cdencryptionActor 0..1 Class Usage & cardinality
........ name 0..1 string The name of the org
....... hcpartyindividual 1..1 Class the identifier of the individual
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ idriziv 0..1 string the RIZIV individual identifier
........ idinss 0..1 string the Belgian Social Security Number identifier
Example Example: 69060733632
........ idencryptionActor 0..1 integer to be checked: usage & cardinality
........ cd 1..1 code the type of the hcparty
Example Example: persphysician
........ cdencryptionActor 0..1 Class to be checked: usage & cardinality
........ firstname 0..1 string the first name of the individual
........ familyname 0..1 string the last name of the individual
Example Example: Hendrix
........ address 0..* Class Home, work, ... address(es) of the patient or healthcare party.
......... @id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
......... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
......... cd 1..1 Class Coded value
......... nis 0..1 code explanation: https://nl.wikipedia.org/wiki/NIS-code
Example Example: 24062
........ telecom 0..* string Fax, phone, … number(s) of the healthcare party.
....... hcpartyapplication 0..1 Class the software identifier
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ itemId 0..1 string the software identifier
........ cd 1..1 code the type of the hcparty
........ name 0..1 string The name of the application.
...... isComplete 1..1 boolean is complete
...... isValidated 1..1 boolean is validated
...... itemmedication 0..* Class This describes the medication it is linked to, but has no further relevance
....... @id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... itemId 0..* integer a sequential unique item ID within the transaction, start=1
....... cd 0..* ANY describes the item category
....... beginMoment 1..1 Class The beginmoment of the medication/treatment suspension
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ date 1..1 date Date
........ time 0..1 time Time
....... endMoment 0..1 Class the end date (and time) of the suspension
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ date 1..1 date Date
........ time 0..1 time Time
....... content 0..* Class To Do
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ medicinalproduct 0..* Class Description of the medicinal product
......... @id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
......... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
......... intendedName 0..1 ST Name of prescribed product
......... intendedCd 0..1 CD CD-DRUG-CNK + Code (CNK)
......... deliveredName 0..1 ST Name of delivered product
......... deliveredCd 0..1 CD CD-DRUG-CNK + Code (CNK)
........ substanceproduct 0..* Class Description of the generic product
......... @id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
......... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
......... intendedName 0..1 ST Name of prescribed product
Example Example: chloorfenamine + paracetamol oraal 3,2 mg + 240 mg
......... intendedCd 0..1 CD Code of prescribed product (VMPGROUP or CNK)
......... deliveredName 0..1 ST Name of delivered product
......... deliveredCd 0..1 CD Code of delivered product (CNK)
........ compoundprescription 0..* Class Description of the compound product
......... @id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
......... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
......... magistraltext 1..1 ST Recipe of the prescription
Example Example: R/ Aluminiumchloride hexahydraat 15 g + Isopropylalcohol 78 g + Gezuiverd water q.s. ad 100 g T
....... text 0..* string Mandatory if compoundprescription is used - !!to be checked if possible in TS transaction!!
....... lifecycle 1..1 string The indication of the status, only used in a TS with value 'suspended'
....... lnk 1..1 string using a link to the transaction (in the current MedicationSchema) of the related medicine
...... itemtransactionreason 0..1 Class Extra information on the reason of suspention of the linked medication
....... @id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... itemId 0..* integer a sequential unique item ID within the transaction, start=1
....... cd 0..* ANY describes the item category
....... contenttext 0..* Class Text
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ text 1..* string cardinality to be checked

Example Example: Temporairement ne pas prendre en raison de l'interaction avec Y.
..... MSETransactionmedication 0..* Class The medication lines
...... @id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... idkmehr 1..1 integer the KMEHR identifier for the medication line
...... idother 0..* string Local ID of the medication line
...... cd 0..* code Coded value
...... date 1..1 date The date when the line was registered in the schema
...... time 1..1 date The time when the line was registered in the schema
...... author 1..1 Class The author of the line in the schema
....... @id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... hcpartyHub 0..1 Class the identifier of the hub
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ itemId 1..1 string the hub identifier
Example Example: 1990001916
........ cd 1..1 code the type of the hcparty
........ name 0..1 string the name of the hub
....... hcpartyOrg 0..1 Class the identifier of the org
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ itemId 0..1 string the org identifier - NIHDII number of the org
Example Example: 1990001916
........ cd 1..1 code the type of the hcparty
........ idencryptionActor 0..1 integer to be checked: usage & cardinality
........ idencryptionApplication 0..1 ANY Application
........ cdencryptionActor 0..1 Class Usage & cardinality
........ name 0..1 string The name of the org
....... hcpartyindividual 1..1 Class the identifier of the individual
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ idriziv 0..1 string the RIZIV individual identifier
........ idinss 0..1 string the Belgian Social Security Number identifier
Example Example: 69060733632
........ idencryptionActor 0..1 integer to be checked: usage & cardinality
........ cd 1..1 code the type of the hcparty
Example Example: persphysician
........ cdencryptionActor 0..1 Class to be checked: usage & cardinality
........ firstname 0..1 string the first name of the individual
........ familyname 0..1 string the last name of the individual
Example Example: Hendrix
........ address 0..* Class Home, work, ... address(es) of the patient or healthcare party.
......... @id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
......... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
......... cd 1..1 Class Coded value
......... nis 0..1 code explanation: https://nl.wikipedia.org/wiki/NIS-code
Example Example: 24062
........ telecom 0..* string Fax, phone, … number(s) of the healthcare party.
....... hcpartyapplication 0..1 Class the software identifier
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ itemId 0..1 string the software identifier
........ cd 1..1 code the type of the hcparty
........ name 0..1 string The name of the application.
...... isComplete 1..1 boolean is complete
...... isValidated 1..1 boolean is validated
...... version 0..* string TO DO
...... itemmedicationUse 0..1 Class Extra information on the usage of the medication within this transaction
....... @id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... itemId 0..* integer a sequential unique item ID within the transaction, start=1
....... cd 0..* ANY describes the item category
....... contentcategory 1..* Class Category
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ cd 0..* Class Coded value
....... contenttext 0..* Class Text
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ text 1..* string cardinality to be checked

Example Example: pression artérielle
...... itemendCondition 0..1 Class Extra information on the endcondition of the medication within this MSE-transaction
....... @id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... itemId 0..* integer a sequential unique item ID within the transaction, start=1
....... cd 0..* ANY describes the item category
....... contentcategory 1..* Class Category
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ cd 0..* Class Coded value
....... contenttext 0..* Class Text
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ text 1..* string cardinality to be checked

Example Example: pression artérielle
...... itembeginCondition 0..1 Class Extra information on the begincondition of the medication within this MSE-transaction
....... @id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... itemId 0..* integer a sequential unique item ID within the transaction, start=1
....... cd 0..* ANY describes the item category
....... contentcategory 1..* Class Category
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ cd 0..* Class Coded value
....... contenttext 0..* Class Text
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ text 1..* string cardinality to be checked

Example Example: pression artérielle
...... itemmedication 0..* Class To Do
....... @id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... itemId 0..* integer a sequential unique item ID within the transaction, start=1
....... cd 0..* ANY describes the item category
....... beginMoment 1..1 Class The beginmoment of the medication/treatment suspension
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ date 1..1 date Date
........ time 0..1 time Time
....... endMoment 0..1 Class The end moment of the medication/treatment suspension
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ date 1..1 date Date
........ time 0..1 time Time
....... duration 0..1 integer The duration of the treatment
....... contentmedicationIdentification 0..* Class To Do
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ medicinalproduct 0..* Class Description of the medicinal product
......... @id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
......... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
......... intendedName 0..1 ST Name of prescribed product
......... intendedCd 0..1 CD CD-DRUG-CNK + Code (CNK)
......... deliveredName 0..1 ST Name of delivered product
......... deliveredCd 0..1 CD CD-DRUG-CNK + Code (CNK)
........ substanceproduct 0..* Class Description of the generic product
......... @id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
......... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
......... intendedName 0..1 ST Name of prescribed product
Example Example: chloorfenamine + paracetamol oraal 3,2 mg + 240 mg
......... intendedCd 0..1 CD Code of prescribed product (VMPGROUP or CNK)
......... deliveredName 0..1 ST Name of delivered product
......... deliveredCd 0..1 CD Code of delivered product (CNK)
........ compoundprescription 0..* Class Description of the compound product
......... @id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
......... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
......... magistraltext 1..1 ST Recipe of the prescription
Example Example: R/ Aluminiumchloride hexahydraat 15 g + Isopropylalcohol 78 g + Gezuiverd water q.s. ad 100 g T
....... content 0..* string Extra content field which can be added if neccessary
....... text 0..* string Mandatory if compoundprescription is used

Example Example: Aluminiumchloride transpiratieremmende hydroalcoholische oplossing 15 % TMF
....... temporality 0..* Class The temporality
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ cd 0..1 string Coded value
....... frequency 0..* Class To Do
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ periodicity 0..* Class To Do
......... @id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
......... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
......... cd 0..* ANY S-VALUE=CD-PERIODICITY
....... posology 0..* Class The freetext posology is mutual exclusive with the structured Regimen
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ text 1..1 string Contains the ingestion pattern in textual form
Example Example: tot 4 x per dag 1 tablet
....... regimen 0..* Class To Do
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ date 0..* date date, mostly used icw periodicity=monthly or at a specifiec time of the day
........ weekday 0..* integer Day of the week, mostly used icw periodicity=weekly
......... @id 0..1 string xml:id (or equivalent in JSON)
......... extension 0..* Extension Additional content defined by implementations
......... @value 0..1 integer Primitive value for integer
......... cd 1..1 string the day of the week
Example Example: monday
........ daynumber 0..* integer Daynumber, mostly used icw periodicity=weekly or daily
........ daytime 0..* Class indication of the intake moment
......... @id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
......... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
......... time 1..1 date The time when the line was registered in the schema
......... dayperiod 1..* Class mutual exclusive with <time>
.......... @id 0..1 string Unique id for inter-element referencing
.......... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.......... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.......... cd 0..* string Coded value
........ quantity 1..1 Class To Do
......... @id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
......... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
......... decimal 0..* integer the amount, expressed in a number
......... unit 0..* Class the prescribed administration unit where the decimal applies to
.......... @id 0..1 string Unique id for inter-element referencing
.......... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.......... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.......... cd 0..* string To Do
....... route 0..* Class The drug administration route
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ cd 0..* ANY To Do
....... instructionforpatient 0..1 string Usage instructions for the patient.
Example Example: A diminuer si possible

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. KMEHRMS 0..* Base KMEHR Medication Schema v5.8
Instances of this logical model are not marked to be the target of a Reference
... KMEHRMessage 1..1 Class KMEHR Message
.... header 1..1 Class KMEHR Message header
..... standard 1..1 Class Which version of the standard is used
...... cd 1..1 CD The version of the KMEHR standard used
..... date 0..1 date Date
..... time 0..1 time Time
..... sender 0..1 Class Sender
...... hcpartyHub 0..1 Class the identifier of the hub
....... itemId 1..1 string the hub identifier
Example Example: 1990001916
....... cd 1..1 code the type of the hcparty
....... name 0..1 string the name of the hub
...... hcpartyOrg 0..1 Class the identifier of the org
....... itemId 0..1 string the org identifier - NIHDII number of the org
Example Example: 1990001916
....... cd 1..1 code the type of the hcparty
....... idencryptionActor 0..1 integer to be checked: usage & cardinality
....... idencryptionApplication 0..1 ANY Application
....... cdencryptionActor 0..1 Class Usage & cardinality
....... name 0..1 string The name of the org
...... hcpartyindividual 1..1 Class the identifier of the individual
....... idriziv 0..1 string the RIZIV individual identifier
....... idinss 0..1 string the Belgian Social Security Number identifier
Example Example: 69060733632
....... idencryptionActor 0..1 integer to be checked: usage & cardinality
....... cd 1..1 code the type of the hcparty
Example Example: persphysician
....... cdencryptionActor 0..1 Class to be checked: usage & cardinality
....... firstname 0..1 string the first name of the individual
....... familyname 0..1 string the last name of the individual
Example Example: Hendrix
....... address 0..* Class Home, work, ... address(es) of the patient or healthcare party.
........ cd 1..1 Class Coded value
........ nis 0..1 code explanation: https://nl.wikipedia.org/wiki/NIS-code
Example Example: 24062
....... telecom 0..* string Fax, phone, … number(s) of the healthcare party.
...... hcpartyapplication 0..1 Class the software identifier
....... itemId 0..1 string the software identifier
....... cd 1..1 code the type of the hcparty
....... name 0..1 string The name of the application.
..... recipient 0..1 Class Recipient
...... hcpartyHub 0..1 Class the identifier of the hub
....... itemId 1..1 string the hub identifier
Example Example: 1990001916
....... cd 1..1 code the type of the hcparty
....... name 0..1 string the name of the hub
...... hcpartyOrg 0..1 Class the identifier of the org
....... itemId 0..1 string the org identifier - NIHDII number of the org
Example Example: 1990001916
....... cd 1..1 code the type of the hcparty
....... idencryptionActor 0..1 integer to be checked: usage & cardinality
....... idencryptionApplication 0..1 ANY Application
....... cdencryptionActor 0..1 Class Usage & cardinality
....... name 0..1 string The name of the org
...... hcpartyindividual 1..1 Class the identifier of the individual
....... idriziv 0..1 string the RIZIV individual identifier
....... idinss 0..1 string the Belgian Social Security Number identifier
Example Example: 69060733632
....... idencryptionActor 0..1 integer to be checked: usage & cardinality
....... cd 1..1 code the type of the hcparty
Example Example: persphysician
....... cdencryptionActor 0..1 Class to be checked: usage & cardinality
....... firstname 0..1 string the first name of the individual
....... familyname 0..1 string the last name of the individual
Example Example: Hendrix
....... address 0..* Class Home, work, ... address(es) of the patient or healthcare party.
........ cd 1..1 Class Coded value
........ nis 0..1 code explanation: https://nl.wikipedia.org/wiki/NIS-code
Example Example: 24062
....... telecom 0..* string Fax, phone, … number(s) of the healthcare party.
...... hcpartyapplication 0..1 Class the software identifier
....... itemId 0..1 string the software identifier
....... cd 1..1 code the type of the hcparty
....... name 0..1 string The name of the application.
.... folder 1..1 Class The only data that matters
..... idkmehr 1..1 integer ID-KMEHR
..... patient 1..1 Class the patient
...... idinss 0..1 string the Belgian Social Security Number identifier
...... firstname 0..1 string First name of the patient. If no first name exists, the element will be empty.
...... familyname 0..1 string Family name of the patient
...... birthdate 0..1 date Birth date of the patient (uses the basic data types for dates)
...... deathdate 0..1 date this is not used
...... sex 1..1 Class Sex of the patient
....... cd 1..1 code Coded value of patient sex
...... address 0..1 Class Home, work, … address(es) of the patient.
....... cd 1..1 code Coded value
....... zip 0..1 integer Zip-code of the city
....... city 0..1 string The name of the city
....... street 0..1 string The name of the street
....... housenumber 0..1 string Housenumber within the street
...... nationality 0..1 string Nationality of the patient. Initially, the use of the CD-COUNTRY dictionary was required. We now recommend the use of the CD-FED-COUNTRY dictionary.
....... cd 1..1 code Coded value
...... usuallanguage 0..1 string Usual language of the patient using the W3C language codes.
...... telecom 0..1 string Fax, phone, … number(s) of the patient.
...... recorddatetime 0..1 ANY Date of recording of the patient data.
...... text 0..1 string Comment about the patient.
..... MSTransaction 1..1 Class The metadata for the message
...... idothers 0..* integer Local ID of the medication line
...... cd 1..1 code code
...... date 1..1 date The date when the line was registered in the schema
...... time 1..1 date The time when the line was registered in the schema
...... author 1..1 Class The author of the line in the schema
....... hcpartyHub 0..1 Class the identifier of the hub
........ itemId 1..1 string the hub identifier
Example Example: 1990001916
........ cd 1..1 code the type of the hcparty
........ name 0..1 string the name of the hub
....... hcpartyOrg 0..1 Class the identifier of the org
........ itemId 0..1 string the org identifier - NIHDII number of the org
Example Example: 1990001916
........ cd 1..1 code the type of the hcparty
........ idencryptionActor 0..1 integer to be checked: usage & cardinality
........ idencryptionApplication 0..1 ANY Application
........ cdencryptionActor 0..1 Class Usage & cardinality
........ name 0..1 string The name of the org
....... hcpartyindividual 1..1 Class the identifier of the individual
........ idriziv 0..1 string the RIZIV individual identifier
........ idinss 0..1 string the Belgian Social Security Number identifier
Example Example: 69060733632
........ idencryptionActor 0..1 integer to be checked: usage & cardinality
........ cd 1..1 code the type of the hcparty
Example Example: persphysician
........ cdencryptionActor 0..1 Class to be checked: usage & cardinality
........ firstname 0..1 string the first name of the individual
........ familyname 0..1 string the last name of the individual
Example Example: Hendrix
........ address 0..* Class Home, work, ... address(es) of the patient or healthcare party.
......... cd 1..1 Class Coded value
......... nis 0..1 code explanation: https://nl.wikipedia.org/wiki/NIS-code
Example Example: 24062
........ telecom 0..* string Fax, phone, … number(s) of the healthcare party.
....... hcpartyapplication 0..1 Class the software identifier
........ itemId 0..1 string the software identifier
........ cd 1..1 code the type of the hcparty
........ name 0..1 string The name of the application.
...... isComplete 1..1 boolean is complete
...... isValidated 1..1 boolean is validated
...... version 0..1 integer version of the medication scheme
..... MSETransactionTreatmentSuspension 0..* Class The treatment suspension line(s)
...... idkmehr 1..1 integer the KMEHR identifier for the medication line
...... idother 0..* string Local ID of the medication line
...... cd 0..* code Coded value
...... date 1..1 date The date when the line was registered in the schema
...... time 1..1 date The time when the line was registered in the schema
...... author 1..1 Class The author of the line in the schema
....... hcpartyHub 0..1 Class the identifier of the hub
........ itemId 1..1 string the hub identifier
Example Example: 1990001916
........ cd 1..1 code the type of the hcparty
........ name 0..1 string the name of the hub
....... hcpartyOrg 0..1 Class the identifier of the org
........ itemId 0..1 string the org identifier - NIHDII number of the org
Example Example: 1990001916
........ cd 1..1 code the type of the hcparty
........ idencryptionActor 0..1 integer to be checked: usage & cardinality
........ idencryptionApplication 0..1 ANY Application
........ cdencryptionActor 0..1 Class Usage & cardinality
........ name 0..1 string The name of the org
....... hcpartyindividual 1..1 Class the identifier of the individual
........ idriziv 0..1 string the RIZIV individual identifier
........ idinss 0..1 string the Belgian Social Security Number identifier
Example Example: 69060733632
........ idencryptionActor 0..1 integer to be checked: usage & cardinality
........ cd 1..1 code the type of the hcparty
Example Example: persphysician
........ cdencryptionActor 0..1 Class to be checked: usage & cardinality
........ firstname 0..1 string the first name of the individual
........ familyname 0..1 string the last name of the individual
Example Example: Hendrix
........ address 0..* Class Home, work, ... address(es) of the patient or healthcare party.
......... cd 1..1 Class Coded value
......... nis 0..1 code explanation: https://nl.wikipedia.org/wiki/NIS-code
Example Example: 24062
........ telecom 0..* string Fax, phone, … number(s) of the healthcare party.
....... hcpartyapplication 0..1 Class the software identifier
........ itemId 0..1 string the software identifier
........ cd 1..1 code the type of the hcparty
........ name 0..1 string The name of the application.
...... isComplete 1..1 boolean is complete
...... isValidated 1..1 boolean is validated
...... itemmedication 0..* Class This describes the medication it is linked to, but has no further relevance
....... itemId 0..* integer a sequential unique item ID within the transaction, start=1
....... cd 0..* ANY describes the item category
....... beginMoment 1..1 Class The beginmoment of the medication/treatment suspension
........ date 1..1 date Date
........ time 0..1 time Time
....... endMoment 0..1 Class the end date (and time) of the suspension
........ date 1..1 date Date
........ time 0..1 time Time
....... content 0..* Class To Do
........ medicinalproduct 0..* Class Description of the medicinal product
......... intendedName 0..1 ST Name of prescribed product
......... intendedCd 0..1 CD CD-DRUG-CNK + Code (CNK)
......... deliveredName 0..1 ST Name of delivered product
......... deliveredCd 0..1 CD CD-DRUG-CNK + Code (CNK)
........ substanceproduct 0..* Class Description of the generic product
......... intendedName 0..1 ST Name of prescribed product
Example Example: chloorfenamine + paracetamol oraal 3,2 mg + 240 mg
......... intendedCd 0..1 CD Code of prescribed product (VMPGROUP or CNK)
......... deliveredName 0..1 ST Name of delivered product
......... deliveredCd 0..1 CD Code of delivered product (CNK)
........ compoundprescription 0..* Class Description of the compound product
......... magistraltext 1..1 ST Recipe of the prescription
Example Example: R/ Aluminiumchloride hexahydraat 15 g + Isopropylalcohol 78 g + Gezuiverd water q.s. ad 100 g T
......... compound 0..0
......... formularyReference 0..0
....... text 0..* string Mandatory if compoundprescription is used - !!to be checked if possible in TS transaction!!
....... lifecycle 1..1 string The indication of the status, only used in a TS with value 'suspended'
....... lnk 1..1 string using a link to the transaction (in the current MedicationSchema) of the related medicine
...... itemtransactionreason 0..1 Class Extra information on the reason of suspention of the linked medication
....... itemId 0..* integer a sequential unique item ID within the transaction, start=1
....... cd 0..* ANY describes the item category
....... contenttext 0..* Class Text
........ text 1..* string cardinality to be checked

Example Example: Temporairement ne pas prendre en raison de l'interaction avec Y.
..... MSETransactionmedication 0..* Class The medication lines
...... idkmehr 1..1 integer the KMEHR identifier for the medication line
...... idother 0..* string Local ID of the medication line
...... cd 0..* code Coded value
...... date 1..1 date The date when the line was registered in the schema
...... time 1..1 date The time when the line was registered in the schema
...... author 1..1 Class The author of the line in the schema
....... hcpartyHub 0..1 Class the identifier of the hub
........ itemId 1..1 string the hub identifier
Example Example: 1990001916
........ cd 1..1 code the type of the hcparty
........ name 0..1 string the name of the hub
....... hcpartyOrg 0..1 Class the identifier of the org
........ itemId 0..1 string the org identifier - NIHDII number of the org
Example Example: 1990001916
........ cd 1..1 code the type of the hcparty
........ idencryptionActor 0..1 integer to be checked: usage & cardinality
........ idencryptionApplication 0..1 ANY Application
........ cdencryptionActor 0..1 Class Usage & cardinality
........ name 0..1 string The name of the org
....... hcpartyindividual 1..1 Class the identifier of the individual
........ idriziv 0..1 string the RIZIV individual identifier
........ idinss 0..1 string the Belgian Social Security Number identifier
Example Example: 69060733632
........ idencryptionActor 0..1 integer to be checked: usage & cardinality
........ cd 1..1 code the type of the hcparty
Example Example: persphysician
........ cdencryptionActor 0..1 Class to be checked: usage & cardinality
........ firstname 0..1 string the first name of the individual
........ familyname 0..1 string the last name of the individual
Example Example: Hendrix
........ address 0..* Class Home, work, ... address(es) of the patient or healthcare party.
......... cd 1..1 Class Coded value
......... nis 0..1 code explanation: https://nl.wikipedia.org/wiki/NIS-code
Example Example: 24062
........ telecom 0..* string Fax, phone, … number(s) of the healthcare party.
....... hcpartyapplication 0..1 Class the software identifier
........ itemId 0..1 string the software identifier
........ cd 1..1 code the type of the hcparty
........ name 0..1 string The name of the application.
...... isComplete 1..1 boolean is complete
...... isValidated 1..1 boolean is validated
...... version 0..* string TO DO
...... itemmedicationUse 0..1 Class Extra information on the usage of the medication within this transaction
....... itemId 0..* integer a sequential unique item ID within the transaction, start=1
....... cd 0..* ANY describes the item category
....... contentcategory 1..* Class Category
........ cd 0..* Class Coded value
....... contenttext 0..* Class Text
........ text 1..* string cardinality to be checked

Example Example: pression artérielle
...... itemendCondition 0..1 Class Extra information on the endcondition of the medication within this MSE-transaction
....... itemId 0..* integer a sequential unique item ID within the transaction, start=1
....... cd 0..* ANY describes the item category
....... contentcategory 1..* Class Category
........ cd 0..* Class Coded value
....... contenttext 0..* Class Text
........ text 1..* string cardinality to be checked

Example Example: pression artérielle
...... itembeginCondition 0..1 Class Extra information on the begincondition of the medication within this MSE-transaction
....... itemId 0..* integer a sequential unique item ID within the transaction, start=1
....... cd 0..* ANY describes the item category
....... contentcategory 1..* Class Category
........ cd 0..* Class Coded value
....... contenttext 0..* Class Text
........ text 1..* string cardinality to be checked

Example Example: pression artérielle
...... itemorigin 0..0
...... itemmedicationType 0..0
...... itemadaptationFlag 0..0
...... itemmedication 0..* Class To Do
....... itemId 0..* integer a sequential unique item ID within the transaction, start=1
....... cd 0..* ANY describes the item category
....... beginMoment 1..1 Class The beginmoment of the medication/treatment suspension
........ date 1..1 date Date
........ time 0..1 time Time
....... endMoment 0..1 Class The end moment of the medication/treatment suspension
........ date 1..1 date Date
........ time 0..1 time Time
....... duration 0..1 integer The duration of the treatment
....... contentmedicationIdentification 0..* Class To Do
........ medicinalproduct 0..* Class Description of the medicinal product
......... intendedName 0..1 ST Name of prescribed product
......... intendedCd 0..1 CD CD-DRUG-CNK + Code (CNK)
......... deliveredName 0..1 ST Name of delivered product
......... deliveredCd 0..1 CD CD-DRUG-CNK + Code (CNK)
........ substanceproduct 0..* Class Description of the generic product
......... intendedName 0..1 ST Name of prescribed product
Example Example: chloorfenamine + paracetamol oraal 3,2 mg + 240 mg
......... intendedCd 0..1 CD Code of prescribed product (VMPGROUP or CNK)
......... deliveredName 0..1 ST Name of delivered product
......... deliveredCd 0..1 CD Code of delivered product (CNK)
........ compoundprescription 0..* Class Description of the compound product
......... magistraltext 1..1 ST Recipe of the prescription
Example Example: R/ Aluminiumchloride hexahydraat 15 g + Isopropylalcohol 78 g + Gezuiverd water q.s. ad 100 g T
......... compound 0..0
......... formularyReference 0..0
....... content 0..* string Extra content field which can be added if neccessary
....... text 0..* string Mandatory if compoundprescription is used

Example Example: Aluminiumchloride transpiratieremmende hydroalcoholische oplossing 15 % TMF
....... temporality 0..* Class The temporality
........ cd 0..1 string Coded value
....... frequency 0..* Class To Do
........ periodicity 0..* Class To Do
......... cd 0..* ANY S-VALUE=CD-PERIODICITY
....... posology 0..* Class The freetext posology is mutual exclusive with the structured Regimen
........ text 1..1 string Contains the ingestion pattern in textual form
Example Example: tot 4 x per dag 1 tablet
........ low 0..0
........ high 0..0
........ unit 0..0
........ takes 0..0
....... regimen 0..* Class To Do
........ date 0..* date date, mostly used icw periodicity=monthly or at a specifiec time of the day
........ weekday 0..* integer Day of the week, mostly used icw periodicity=weekly
......... cd 1..1 string the day of the week
Example Example: monday
........ daynumber 0..* integer Daynumber, mostly used icw periodicity=weekly or daily
........ daytime 0..* Class indication of the intake moment
......... time 1..1 date The time when the line was registered in the schema
......... dayperiod 1..* Class mutual exclusive with <time>
.......... cd 0..* string Coded value
........ quantity 1..1 Class To Do
......... decimal 0..* integer the amount, expressed in a number
......... unit 0..* Class the prescribed administration unit where the decimal applies to
.......... cd 0..* string To Do
....... route 0..* Class The drug administration route
........ cd 0..* ANY To Do
....... instructionForOverDosing 0..0
....... instructionForReimbursement 0..0
....... isSubstitutionAllowed 0..0
....... feedback 0..0
....... local 0..0
....... batch 0..0
....... deliveryDate 0..0
....... instructionforpatient 0..1 string Usage instructions for the patient.
Example Example: A diminuer si possible

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. KMEHRMS 0..* Base KMEHR Medication Schema v5.8
Instances of this logical model are not marked to be the target of a Reference
... KMEHRMessage 1..1 Class KMEHR Message
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... header 1..1 Class KMEHR Message header
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... standard 1..1 Class Which version of the standard is used
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... cd 1..1 CD The version of the KMEHR standard used
..... date 0..1 date Date
..... time 0..1 time Time
..... sender 0..1 Class Sender
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... hcpartyHub 0..1 Class the identifier of the hub
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... itemId 1..1 string the hub identifier
Example Example: 1990001916
....... cd 1..1 code the type of the hcparty
....... name 0..1 string the name of the hub
...... hcpartyOrg 0..1 Class the identifier of the org
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... itemId 0..1 string the org identifier - NIHDII number of the org
Example Example: 1990001916
....... cd 1..1 code the type of the hcparty
....... idencryptionActor 0..1 integer to be checked: usage & cardinality
....... idencryptionApplication 0..1 ANY Application
....... cdencryptionActor 0..1 Class Usage & cardinality
....... name 0..1 string The name of the org
...... hcpartyindividual 1..1 Class the identifier of the individual
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... idriziv 0..1 string the RIZIV individual identifier
....... idinss 0..1 string the Belgian Social Security Number identifier
Example Example: 69060733632
....... idencryptionActor 0..1 integer to be checked: usage & cardinality
....... cd 1..1 code the type of the hcparty
Example Example: persphysician
....... cdencryptionActor 0..1 Class to be checked: usage & cardinality
....... firstname 0..1 string the first name of the individual
....... familyname 0..1 string the last name of the individual
Example Example: Hendrix
....... address 0..* Class Home, work, ... address(es) of the patient or healthcare party.
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ cd 1..1 Class Coded value
........ nis 0..1 code explanation: https://nl.wikipedia.org/wiki/NIS-code
Example Example: 24062
....... telecom 0..* string Fax, phone, … number(s) of the healthcare party.
...... hcpartyapplication 0..1 Class the software identifier
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... itemId 0..1 string the software identifier
....... cd 1..1 code the type of the hcparty
....... name 0..1 string The name of the application.
..... recipient 0..1 Class Recipient
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... hcpartyHub 0..1 Class the identifier of the hub
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... itemId 1..1 string the hub identifier
Example Example: 1990001916
....... cd 1..1 code the type of the hcparty
....... name 0..1 string the name of the hub
...... hcpartyOrg 0..1 Class the identifier of the org
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... itemId 0..1 string the org identifier - NIHDII number of the org
Example Example: 1990001916
....... cd 1..1 code the type of the hcparty
....... idencryptionActor 0..1 integer to be checked: usage & cardinality
....... idencryptionApplication 0..1 ANY Application
....... cdencryptionActor 0..1 Class Usage & cardinality
....... name 0..1 string The name of the org
...... hcpartyindividual 1..1 Class the identifier of the individual
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... idriziv 0..1 string the RIZIV individual identifier
....... idinss 0..1 string the Belgian Social Security Number identifier
Example Example: 69060733632
....... idencryptionActor 0..1 integer to be checked: usage & cardinality
....... cd 1..1 code the type of the hcparty
Example Example: persphysician
....... cdencryptionActor 0..1 Class to be checked: usage & cardinality
....... firstname 0..1 string the first name of the individual
....... familyname 0..1 string the last name of the individual
Example Example: Hendrix
....... address 0..* Class Home, work, ... address(es) of the patient or healthcare party.
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ cd 1..1 Class Coded value
........ nis 0..1 code explanation: https://nl.wikipedia.org/wiki/NIS-code
Example Example: 24062
....... telecom 0..* string Fax, phone, … number(s) of the healthcare party.
...... hcpartyapplication 0..1 Class the software identifier
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... itemId 0..1 string the software identifier
....... cd 1..1 code the type of the hcparty
....... name 0..1 string The name of the application.
.... folder 1..1 Class The only data that matters
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... idkmehr 1..1 integer ID-KMEHR
..... patient 1..1 Class the patient
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... idinss 0..1 string the Belgian Social Security Number identifier
...... firstname 0..1 string First name of the patient. If no first name exists, the element will be empty.
...... familyname 0..1 string Family name of the patient
...... birthdate 0..1 date Birth date of the patient (uses the basic data types for dates)
...... deathdate 0..1 date this is not used
...... sex 1..1 Class Sex of the patient
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... cd 1..1 code Coded value of patient sex
...... address 0..1 Class Home, work, … address(es) of the patient.
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... cd 1..1 code Coded value
....... zip 0..1 integer Zip-code of the city
....... city 0..1 string The name of the city
....... street 0..1 string The name of the street
....... housenumber 0..1 string Housenumber within the street
...... nationality 0..1 string Nationality of the patient. Initially, the use of the CD-COUNTRY dictionary was required. We now recommend the use of the CD-FED-COUNTRY dictionary.
....... cd 1..1 code Coded value
...... usuallanguage 0..1 string Usual language of the patient using the W3C language codes.
...... telecom 0..1 string Fax, phone, … number(s) of the patient.
...... recorddatetime 0..1 ANY Date of recording of the patient data.
...... text 0..1 string Comment about the patient.
..... MSTransaction 1..1 Class The metadata for the message
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... idothers 0..* integer Local ID of the medication line
...... cd 1..1 code code
...... date 1..1 date The date when the line was registered in the schema
...... time 1..1 date The time when the line was registered in the schema
...... author 1..1 Class The author of the line in the schema
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... hcpartyHub 0..1 Class the identifier of the hub
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ itemId 1..1 string the hub identifier
Example Example: 1990001916
........ cd 1..1 code the type of the hcparty
........ name 0..1 string the name of the hub
....... hcpartyOrg 0..1 Class the identifier of the org
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ itemId 0..1 string the org identifier - NIHDII number of the org
Example Example: 1990001916
........ cd 1..1 code the type of the hcparty
........ idencryptionActor 0..1 integer to be checked: usage & cardinality
........ idencryptionApplication 0..1 ANY Application
........ cdencryptionActor 0..1 Class Usage & cardinality
........ name 0..1 string The name of the org
....... hcpartyindividual 1..1 Class the identifier of the individual
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ idriziv 0..1 string the RIZIV individual identifier
........ idinss 0..1 string the Belgian Social Security Number identifier
Example Example: 69060733632
........ idencryptionActor 0..1 integer to be checked: usage & cardinality
........ cd 1..1 code the type of the hcparty
Example Example: persphysician
........ cdencryptionActor 0..1 Class to be checked: usage & cardinality
........ firstname 0..1 string the first name of the individual
........ familyname 0..1 string the last name of the individual
Example Example: Hendrix
........ address 0..* Class Home, work, ... address(es) of the patient or healthcare party.
......... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
......... cd 1..1 Class Coded value
......... nis 0..1 code explanation: https://nl.wikipedia.org/wiki/NIS-code
Example Example: 24062
........ telecom 0..* string Fax, phone, … number(s) of the healthcare party.
....... hcpartyapplication 0..1 Class the software identifier
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ itemId 0..1 string the software identifier
........ cd 1..1 code the type of the hcparty
........ name 0..1 string The name of the application.
...... isComplete 1..1 boolean is complete
...... isValidated 1..1 boolean is validated
...... version 0..1 integer version of the medication scheme
..... MSETransactionTreatmentSuspension 0..* Class The treatment suspension line(s)
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... idkmehr 1..1 integer the KMEHR identifier for the medication line
...... idother 0..* string Local ID of the medication line
...... cd 0..* code Coded value
...... date 1..1 date The date when the line was registered in the schema
...... time 1..1 date The time when the line was registered in the schema
...... author 1..1 Class The author of the line in the schema
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... hcpartyHub 0..1 Class the identifier of the hub
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ itemId 1..1 string the hub identifier
Example Example: 1990001916
........ cd 1..1 code the type of the hcparty
........ name 0..1 string the name of the hub
....... hcpartyOrg 0..1 Class the identifier of the org
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ itemId 0..1 string the org identifier - NIHDII number of the org
Example Example: 1990001916
........ cd 1..1 code the type of the hcparty
........ idencryptionActor 0..1 integer to be checked: usage & cardinality
........ idencryptionApplication 0..1 ANY Application
........ cdencryptionActor 0..1 Class Usage & cardinality
........ name 0..1 string The name of the org
....... hcpartyindividual 1..1 Class the identifier of the individual
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ idriziv 0..1 string the RIZIV individual identifier
........ idinss 0..1 string the Belgian Social Security Number identifier
Example Example: 69060733632
........ idencryptionActor 0..1 integer to be checked: usage & cardinality
........ cd 1..1 code the type of the hcparty
Example Example: persphysician
........ cdencryptionActor 0..1 Class to be checked: usage & cardinality
........ firstname 0..1 string the first name of the individual
........ familyname 0..1 string the last name of the individual
Example Example: Hendrix
........ address 0..* Class Home, work, ... address(es) of the patient or healthcare party.
......... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
......... cd 1..1 Class Coded value
......... nis 0..1 code explanation: https://nl.wikipedia.org/wiki/NIS-code
Example Example: 24062
........ telecom 0..* string Fax, phone, … number(s) of the healthcare party.
....... hcpartyapplication 0..1 Class the software identifier
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ itemId 0..1 string the software identifier
........ cd 1..1 code the type of the hcparty
........ name 0..1 string The name of the application.
...... isComplete 1..1 boolean is complete
...... isValidated 1..1 boolean is validated
...... itemmedication 0..* Class This describes the medication it is linked to, but has no further relevance
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... itemId 0..* integer a sequential unique item ID within the transaction, start=1
....... cd 0..* ANY describes the item category
....... beginMoment 1..1 Class The beginmoment of the medication/treatment suspension
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ date 1..1 date Date
........ time 0..1 time Time
....... endMoment 0..1 Class the end date (and time) of the suspension
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ date 1..1 date Date
........ time 0..1 time Time
....... content 0..* Class To Do
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ medicinalproduct 0..* Class Description of the medicinal product
......... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
......... intendedName 0..1 ST Name of prescribed product
......... intendedCd 0..1 CD CD-DRUG-CNK + Code (CNK)
......... deliveredName 0..1 ST Name of delivered product
......... deliveredCd 0..1 CD CD-DRUG-CNK + Code (CNK)
........ substanceproduct 0..* Class Description of the generic product
......... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
......... intendedName 0..1 ST Name of prescribed product
Example Example: chloorfenamine + paracetamol oraal 3,2 mg + 240 mg
......... intendedCd 0..1 CD Code of prescribed product (VMPGROUP or CNK)
......... deliveredName 0..1 ST Name of delivered product
......... deliveredCd 0..1 CD Code of delivered product (CNK)
........ compoundprescription 0..* Class Description of the compound product
......... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
......... magistraltext 1..1 ST Recipe of the prescription
Example Example: R/ Aluminiumchloride hexahydraat 15 g + Isopropylalcohol 78 g + Gezuiverd water q.s. ad 100 g T
....... text 0..* string Mandatory if compoundprescription is used - !!to be checked if possible in TS transaction!!
....... lifecycle 1..1 string The indication of the status, only used in a TS with value 'suspended'
....... lnk 1..1 string using a link to the transaction (in the current MedicationSchema) of the related medicine
...... itemtransactionreason 0..1 Class Extra information on the reason of suspention of the linked medication
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... itemId 0..* integer a sequential unique item ID within the transaction, start=1
....... cd 0..* ANY describes the item category
....... contenttext 0..* Class Text
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ text 1..* string cardinality to be checked

Example Example: Temporairement ne pas prendre en raison de l'interaction avec Y.
..... MSETransactionmedication 0..* Class The medication lines
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... idkmehr 1..1 integer the KMEHR identifier for the medication line
...... idother 0..* string Local ID of the medication line
...... cd 0..* code Coded value
...... date 1..1 date The date when the line was registered in the schema
...... time 1..1 date The time when the line was registered in the schema
...... author 1..1 Class The author of the line in the schema
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... hcpartyHub 0..1 Class the identifier of the hub
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ itemId 1..1 string the hub identifier
Example Example: 1990001916
........ cd 1..1 code the type of the hcparty
........ name 0..1 string the name of the hub
....... hcpartyOrg 0..1 Class the identifier of the org
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ itemId 0..1 string the org identifier - NIHDII number of the org
Example Example: 1990001916
........ cd 1..1 code the type of the hcparty
........ idencryptionActor 0..1 integer to be checked: usage & cardinality
........ idencryptionApplication 0..1 ANY Application
........ cdencryptionActor 0..1 Class Usage & cardinality
........ name 0..1 string The name of the org
....... hcpartyindividual 1..1 Class the identifier of the individual
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ idriziv 0..1 string the RIZIV individual identifier
........ idinss 0..1 string the Belgian Social Security Number identifier
Example Example: 69060733632
........ idencryptionActor 0..1 integer to be checked: usage & cardinality
........ cd 1..1 code the type of the hcparty
Example Example: persphysician
........ cdencryptionActor 0..1 Class to be checked: usage & cardinality
........ firstname 0..1 string the first name of the individual
........ familyname 0..1 string the last name of the individual
Example Example: Hendrix
........ address 0..* Class Home, work, ... address(es) of the patient or healthcare party.
......... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
......... cd 1..1 Class Coded value
......... nis 0..1 code explanation: https://nl.wikipedia.org/wiki/NIS-code
Example Example: 24062
........ telecom 0..* string Fax, phone, … number(s) of the healthcare party.
....... hcpartyapplication 0..1 Class the software identifier
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ itemId 0..1 string the software identifier
........ cd 1..1 code the type of the hcparty
........ name 0..1 string The name of the application.
...... isComplete 1..1 boolean is complete
...... isValidated 1..1 boolean is validated
...... version 0..* string TO DO
...... itemmedicationUse 0..1 Class Extra information on the usage of the medication within this transaction
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... itemId 0..* integer a sequential unique item ID within the transaction, start=1
....... cd 0..* ANY describes the item category
....... contentcategory 1..* Class Category
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ cd 0..* Class Coded value
....... contenttext 0..* Class Text
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ text 1..* string cardinality to be checked

Example Example: pression artérielle
...... itemendCondition 0..1 Class Extra information on the endcondition of the medication within this MSE-transaction
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... itemId 0..* integer a sequential unique item ID within the transaction, start=1
....... cd 0..* ANY describes the item category
....... contentcategory 1..* Class Category
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ cd 0..* Class Coded value
....... contenttext 0..* Class Text
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ text 1..* string cardinality to be checked

Example Example: pression artérielle
...... itembeginCondition 0..1 Class Extra information on the begincondition of the medication within this MSE-transaction
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... itemId 0..* integer a sequential unique item ID within the transaction, start=1
....... cd 0..* ANY describes the item category
....... contentcategory 1..* Class Category
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ cd 0..* Class Coded value
....... contenttext 0..* Class Text
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ text 1..* string cardinality to be checked

Example Example: pression artérielle
...... itemmedication 0..* Class To Do
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... itemId 0..* integer a sequential unique item ID within the transaction, start=1
....... cd 0..* ANY describes the item category
....... beginMoment 1..1 Class The beginmoment of the medication/treatment suspension
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ date 1..1 date Date
........ time 0..1 time Time
....... endMoment 0..1 Class The end moment of the medication/treatment suspension
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ date 1..1 date Date
........ time 0..1 time Time
....... duration 0..1 integer The duration of the treatment
....... contentmedicationIdentification 0..* Class To Do
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ medicinalproduct 0..* Class Description of the medicinal product
......... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
......... intendedName 0..1 ST Name of prescribed product
......... intendedCd 0..1 CD CD-DRUG-CNK + Code (CNK)
......... deliveredName 0..1 ST Name of delivered product
......... deliveredCd 0..1 CD CD-DRUG-CNK + Code (CNK)
........ substanceproduct 0..* Class Description of the generic product
......... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
......... intendedName 0..1 ST Name of prescribed product
Example Example: chloorfenamine + paracetamol oraal 3,2 mg + 240 mg
......... intendedCd 0..1 CD Code of prescribed product (VMPGROUP or CNK)
......... deliveredName 0..1 ST Name of delivered product
......... deliveredCd 0..1 CD Code of delivered product (CNK)
........ compoundprescription 0..* Class Description of the compound product
......... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
......... magistraltext 1..1 ST Recipe of the prescription
Example Example: R/ Aluminiumchloride hexahydraat 15 g + Isopropylalcohol 78 g + Gezuiverd water q.s. ad 100 g T
....... content 0..* string Extra content field which can be added if neccessary
....... text 0..* string Mandatory if compoundprescription is used

Example Example: Aluminiumchloride transpiratieremmende hydroalcoholische oplossing 15 % TMF
....... temporality 0..* Class The temporality
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ cd 0..1 string Coded value
....... frequency 0..* Class To Do
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ periodicity 0..* Class To Do
......... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
......... cd 0..* ANY S-VALUE=CD-PERIODICITY
....... posology 0..* Class The freetext posology is mutual exclusive with the structured Regimen
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ text 1..1 string Contains the ingestion pattern in textual form
Example Example: tot 4 x per dag 1 tablet
....... regimen 0..* Class To Do
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ date 0..* date date, mostly used icw periodicity=monthly or at a specifiec time of the day
........ weekday 0..* integer Day of the week, mostly used icw periodicity=weekly
......... cd 1..1 string the day of the week
Example Example: monday
........ daynumber 0..* integer Daynumber, mostly used icw periodicity=weekly or daily
........ daytime 0..* Class indication of the intake moment
......... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
......... time 1..1 date The time when the line was registered in the schema
......... dayperiod 1..* Class mutual exclusive with <time>
.......... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.......... cd 0..* string Coded value
........ quantity 1..1 Class To Do
......... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
......... decimal 0..* integer the amount, expressed in a number
......... unit 0..* Class the prescribed administration unit where the decimal applies to
.......... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.......... cd 0..* string To Do
....... route 0..* Class The drug administration route
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ cd 0..* ANY To Do
....... instructionforpatient 0..1 string Usage instructions for the patient.
Example Example: A diminuer si possible

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. KMEHRMS 0..* Base KMEHR Medication Schema v5.8
Instances of this logical model are not marked to be the target of a Reference
... KMEHRMessage 1..1 Class KMEHR Message
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... header 1..1 Class KMEHR Message header
..... @id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... standard 1..1 Class Which version of the standard is used
...... @id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... cd 1..1 CD The version of the KMEHR standard used
..... date 0..1 date Date
..... time 0..1 time Time
..... sender 0..1 Class Sender
...... @id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... hcpartyHub 0..1 Class the identifier of the hub
....... @id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... itemId 1..1 string the hub identifier
Example Example: 1990001916
....... cd 1..1 code the type of the hcparty
....... name 0..1 string the name of the hub
...... hcpartyOrg 0..1 Class the identifier of the org
....... @id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... itemId 0..1 string the org identifier - NIHDII number of the org
Example Example: 1990001916
....... cd 1..1 code the type of the hcparty
....... idencryptionActor 0..1 integer to be checked: usage & cardinality
....... idencryptionApplication 0..1 ANY Application
....... cdencryptionActor 0..1 Class Usage & cardinality
....... name 0..1 string The name of the org
...... hcpartyindividual 1..1 Class the identifier of the individual
....... @id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... idriziv 0..1 string the RIZIV individual identifier
....... idinss 0..1 string the Belgian Social Security Number identifier
Example Example: 69060733632
....... idencryptionActor 0..1 integer to be checked: usage & cardinality
....... cd 1..1 code the type of the hcparty
Example Example: persphysician
....... cdencryptionActor 0..1 Class to be checked: usage & cardinality
....... firstname 0..1 string the first name of the individual
....... familyname 0..1 string the last name of the individual
Example Example: Hendrix
....... address 0..* Class Home, work, ... address(es) of the patient or healthcare party.
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ cd 1..1 Class Coded value
........ nis 0..1 code explanation: https://nl.wikipedia.org/wiki/NIS-code
Example Example: 24062
....... telecom 0..* string Fax, phone, … number(s) of the healthcare party.
...... hcpartyapplication 0..1 Class the software identifier
....... @id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... itemId 0..1 string the software identifier
....... cd 1..1 code the type of the hcparty
....... name 0..1 string The name of the application.
..... recipient 0..1 Class Recipient
...... @id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... hcpartyHub 0..1 Class the identifier of the hub
....... @id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... itemId 1..1 string the hub identifier
Example Example: 1990001916
....... cd 1..1 code the type of the hcparty
....... name 0..1 string the name of the hub
...... hcpartyOrg 0..1 Class the identifier of the org
....... @id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... itemId 0..1 string the org identifier - NIHDII number of the org
Example Example: 1990001916
....... cd 1..1 code the type of the hcparty
....... idencryptionActor 0..1 integer to be checked: usage & cardinality
....... idencryptionApplication 0..1 ANY Application
....... cdencryptionActor 0..1 Class Usage & cardinality
....... name 0..1 string The name of the org
...... hcpartyindividual 1..1 Class the identifier of the individual
....... @id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... idriziv 0..1 string the RIZIV individual identifier
....... idinss 0..1 string the Belgian Social Security Number identifier
Example Example: 69060733632
....... idencryptionActor 0..1 integer to be checked: usage & cardinality
....... cd 1..1 code the type of the hcparty
Example Example: persphysician
....... cdencryptionActor 0..1 Class to be checked: usage & cardinality
....... firstname 0..1 string the first name of the individual
....... familyname 0..1 string the last name of the individual
Example Example: Hendrix
....... address 0..* Class Home, work, ... address(es) of the patient or healthcare party.
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ cd 1..1 Class Coded value
........ nis 0..1 code explanation: https://nl.wikipedia.org/wiki/NIS-code
Example Example: 24062
....... telecom 0..* string Fax, phone, … number(s) of the healthcare party.
...... hcpartyapplication 0..1 Class the software identifier
....... @id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... itemId 0..1 string the software identifier
....... cd 1..1 code the type of the hcparty
....... name 0..1 string The name of the application.
.... folder 1..1 Class The only data that matters
..... @id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... idkmehr 1..1 integer ID-KMEHR
..... patient 1..1 Class the patient
...... @id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... idinss 0..1 string the Belgian Social Security Number identifier
...... firstname 0..1 string First name of the patient. If no first name exists, the element will be empty.
...... familyname 0..1 string Family name of the patient
...... birthdate 0..1 date Birth date of the patient (uses the basic data types for dates)
...... deathdate 0..1 date this is not used
...... sex 1..1 Class Sex of the patient
....... @id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... cd 1..1 code Coded value of patient sex
...... address 0..1 Class Home, work, … address(es) of the patient.
....... @id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... cd 1..1 code Coded value
....... zip 0..1 integer Zip-code of the city
....... city 0..1 string The name of the city
....... street 0..1 string The name of the street
....... housenumber 0..1 string Housenumber within the street
...... nationality 0..1 string Nationality of the patient. Initially, the use of the CD-COUNTRY dictionary was required. We now recommend the use of the CD-FED-COUNTRY dictionary.
....... @id 0..1 string xml:id (or equivalent in JSON)
....... extension 0..* Extension Additional content defined by implementations
....... @value 0..1 string Primitive value for string
Max Length: 1048576
....... cd 1..1 code Coded value
...... usuallanguage 0..1 string Usual language of the patient using the W3C language codes.
...... telecom 0..1 string Fax, phone, … number(s) of the patient.
...... recorddatetime 0..1 ANY Date of recording of the patient data.
...... text 0..1 string Comment about the patient.
..... MSTransaction 1..1 Class The metadata for the message
...... @id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... idothers 0..* integer Local ID of the medication line
...... cd 1..1 code code
...... date 1..1 date The date when the line was registered in the schema
...... time 1..1 date The time when the line was registered in the schema
...... author 1..1 Class The author of the line in the schema
....... @id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... hcpartyHub 0..1 Class the identifier of the hub
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ itemId 1..1 string the hub identifier
Example Example: 1990001916
........ cd 1..1 code the type of the hcparty
........ name 0..1 string the name of the hub
....... hcpartyOrg 0..1 Class the identifier of the org
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ itemId 0..1 string the org identifier - NIHDII number of the org
Example Example: 1990001916
........ cd 1..1 code the type of the hcparty
........ idencryptionActor 0..1 integer to be checked: usage & cardinality
........ idencryptionApplication 0..1 ANY Application
........ cdencryptionActor 0..1 Class Usage & cardinality
........ name 0..1 string The name of the org
....... hcpartyindividual 1..1 Class the identifier of the individual
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ idriziv 0..1 string the RIZIV individual identifier
........ idinss 0..1 string the Belgian Social Security Number identifier
Example Example: 69060733632
........ idencryptionActor 0..1 integer to be checked: usage & cardinality
........ cd 1..1 code the type of the hcparty
Example Example: persphysician
........ cdencryptionActor 0..1 Class to be checked: usage & cardinality
........ firstname 0..1 string the first name of the individual
........ familyname 0..1 string the last name of the individual
Example Example: Hendrix
........ address 0..* Class Home, work, ... address(es) of the patient or healthcare party.
......... @id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
......... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
......... cd 1..1 Class Coded value
......... nis 0..1 code explanation: https://nl.wikipedia.org/wiki/NIS-code
Example Example: 24062
........ telecom 0..* string Fax, phone, … number(s) of the healthcare party.
....... hcpartyapplication 0..1 Class the software identifier
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ itemId 0..1 string the software identifier
........ cd 1..1 code the type of the hcparty
........ name 0..1 string The name of the application.
...... isComplete 1..1 boolean is complete
...... isValidated 1..1 boolean is validated
...... version 0..1 integer version of the medication scheme
..... MSETransactionTreatmentSuspension 0..* Class The treatment suspension line(s)
...... @id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... idkmehr 1..1 integer the KMEHR identifier for the medication line
...... idother 0..* string Local ID of the medication line
...... cd 0..* code Coded value
...... date 1..1 date The date when the line was registered in the schema
...... time 1..1 date The time when the line was registered in the schema
...... author 1..1 Class The author of the line in the schema
....... @id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... hcpartyHub 0..1 Class the identifier of the hub
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ itemId 1..1 string the hub identifier
Example Example: 1990001916
........ cd 1..1 code the type of the hcparty
........ name 0..1 string the name of the hub
....... hcpartyOrg 0..1 Class the identifier of the org
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ itemId 0..1 string the org identifier - NIHDII number of the org
Example Example: 1990001916
........ cd 1..1 code the type of the hcparty
........ idencryptionActor 0..1 integer to be checked: usage & cardinality
........ idencryptionApplication 0..1 ANY Application
........ cdencryptionActor 0..1 Class Usage & cardinality
........ name 0..1 string The name of the org
....... hcpartyindividual 1..1 Class the identifier of the individual
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ idriziv 0..1 string the RIZIV individual identifier
........ idinss 0..1 string the Belgian Social Security Number identifier
Example Example: 69060733632
........ idencryptionActor 0..1 integer to be checked: usage & cardinality
........ cd 1..1 code the type of the hcparty
Example Example: persphysician
........ cdencryptionActor 0..1 Class to be checked: usage & cardinality
........ firstname 0..1 string the first name of the individual
........ familyname 0..1 string the last name of the individual
Example Example: Hendrix
........ address 0..* Class Home, work, ... address(es) of the patient or healthcare party.
......... @id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
......... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
......... cd 1..1 Class Coded value
......... nis 0..1 code explanation: https://nl.wikipedia.org/wiki/NIS-code
Example Example: 24062
........ telecom 0..* string Fax, phone, … number(s) of the healthcare party.
....... hcpartyapplication 0..1 Class the software identifier
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ itemId 0..1 string the software identifier
........ cd 1..1 code the type of the hcparty
........ name 0..1 string The name of the application.
...... isComplete 1..1 boolean is complete
...... isValidated 1..1 boolean is validated
...... itemmedication 0..* Class This describes the medication it is linked to, but has no further relevance
....... @id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... itemId 0..* integer a sequential unique item ID within the transaction, start=1
....... cd 0..* ANY describes the item category
....... beginMoment 1..1 Class The beginmoment of the medication/treatment suspension
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ date 1..1 date Date
........ time 0..1 time Time
....... endMoment 0..1 Class the end date (and time) of the suspension
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ date 1..1 date Date
........ time 0..1 time Time
....... content 0..* Class To Do
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ medicinalproduct 0..* Class Description of the medicinal product
......... @id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
......... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
......... intendedName 0..1 ST Name of prescribed product
......... intendedCd 0..1 CD CD-DRUG-CNK + Code (CNK)
......... deliveredName 0..1 ST Name of delivered product
......... deliveredCd 0..1 CD CD-DRUG-CNK + Code (CNK)
........ substanceproduct 0..* Class Description of the generic product
......... @id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
......... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
......... intendedName 0..1 ST Name of prescribed product
Example Example: chloorfenamine + paracetamol oraal 3,2 mg + 240 mg
......... intendedCd 0..1 CD Code of prescribed product (VMPGROUP or CNK)
......... deliveredName 0..1 ST Name of delivered product
......... deliveredCd 0..1 CD Code of delivered product (CNK)
........ compoundprescription 0..* Class Description of the compound product
......... @id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
......... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
......... magistraltext 1..1 ST Recipe of the prescription
Example Example: R/ Aluminiumchloride hexahydraat 15 g + Isopropylalcohol 78 g + Gezuiverd water q.s. ad 100 g T
....... text 0..* string Mandatory if compoundprescription is used - !!to be checked if possible in TS transaction!!
....... lifecycle 1..1 string The indication of the status, only used in a TS with value 'suspended'
....... lnk 1..1 string using a link to the transaction (in the current MedicationSchema) of the related medicine
...... itemtransactionreason 0..1 Class Extra information on the reason of suspention of the linked medication
....... @id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... itemId 0..* integer a sequential unique item ID within the transaction, start=1
....... cd 0..* ANY describes the item category
....... contenttext 0..* Class Text
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ text 1..* string cardinality to be checked

Example Example: Temporairement ne pas prendre en raison de l'interaction avec Y.
..... MSETransactionmedication 0..* Class The medication lines
...... @id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... idkmehr 1..1 integer the KMEHR identifier for the medication line
...... idother 0..* string Local ID of the medication line
...... cd 0..* code Coded value
...... date 1..1 date The date when the line was registered in the schema
...... time 1..1 date The time when the line was registered in the schema
...... author 1..1 Class The author of the line in the schema
....... @id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... hcpartyHub 0..1 Class the identifier of the hub
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ itemId 1..1 string the hub identifier
Example Example: 1990001916
........ cd 1..1 code the type of the hcparty
........ name 0..1 string the name of the hub
....... hcpartyOrg 0..1 Class the identifier of the org
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ itemId 0..1 string the org identifier - NIHDII number of the org
Example Example: 1990001916
........ cd 1..1 code the type of the hcparty
........ idencryptionActor 0..1 integer to be checked: usage & cardinality
........ idencryptionApplication 0..1 ANY Application
........ cdencryptionActor 0..1 Class Usage & cardinality
........ name 0..1 string The name of the org
....... hcpartyindividual 1..1 Class the identifier of the individual
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ idriziv 0..1 string the RIZIV individual identifier
........ idinss 0..1 string the Belgian Social Security Number identifier
Example Example: 69060733632
........ idencryptionActor 0..1 integer to be checked: usage & cardinality
........ cd 1..1 code the type of the hcparty
Example Example: persphysician
........ cdencryptionActor 0..1 Class to be checked: usage & cardinality
........ firstname 0..1 string the first name of the individual
........ familyname 0..1 string the last name of the individual
Example Example: Hendrix
........ address 0..* Class Home, work, ... address(es) of the patient or healthcare party.
......... @id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
......... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
......... cd 1..1 Class Coded value
......... nis 0..1 code explanation: https://nl.wikipedia.org/wiki/NIS-code
Example Example: 24062
........ telecom 0..* string Fax, phone, … number(s) of the healthcare party.
....... hcpartyapplication 0..1 Class the software identifier
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ itemId 0..1 string the software identifier
........ cd 1..1 code the type of the hcparty
........ name 0..1 string The name of the application.
...... isComplete 1..1 boolean is complete
...... isValidated 1..1 boolean is validated
...... version 0..* string TO DO
...... itemmedicationUse 0..1 Class Extra information on the usage of the medication within this transaction
....... @id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... itemId 0..* integer a sequential unique item ID within the transaction, start=1
....... cd 0..* ANY describes the item category
....... contentcategory 1..* Class Category
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ cd 0..* Class Coded value
....... contenttext 0..* Class Text
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ text 1..* string cardinality to be checked

Example Example: pression artérielle
...... itemendCondition 0..1 Class Extra information on the endcondition of the medication within this MSE-transaction
....... @id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... itemId 0..* integer a sequential unique item ID within the transaction, start=1
....... cd 0..* ANY describes the item category
....... contentcategory 1..* Class Category
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ cd 0..* Class Coded value
....... contenttext 0..* Class Text
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ text 1..* string cardinality to be checked

Example Example: pression artérielle
...... itembeginCondition 0..1 Class Extra information on the begincondition of the medication within this MSE-transaction
....... @id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... itemId 0..* integer a sequential unique item ID within the transaction, start=1
....... cd 0..* ANY describes the item category
....... contentcategory 1..* Class Category
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ cd 0..* Class Coded value
....... contenttext 0..* Class Text
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ text 1..* string cardinality to be checked

Example Example: pression artérielle
...... itemmedication 0..* Class To Do
....... @id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... itemId 0..* integer a sequential unique item ID within the transaction, start=1
....... cd 0..* ANY describes the item category
....... beginMoment 1..1 Class The beginmoment of the medication/treatment suspension
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ date 1..1 date Date
........ time 0..1 time Time
....... endMoment 0..1 Class The end moment of the medication/treatment suspension
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ date 1..1 date Date
........ time 0..1 time Time
....... duration 0..1 integer The duration of the treatment
....... contentmedicationIdentification 0..* Class To Do
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ medicinalproduct 0..* Class Description of the medicinal product
......... @id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
......... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
......... intendedName 0..1 ST Name of prescribed product
......... intendedCd 0..1 CD CD-DRUG-CNK + Code (CNK)
......... deliveredName 0..1 ST Name of delivered product
......... deliveredCd 0..1 CD CD-DRUG-CNK + Code (CNK)
........ substanceproduct 0..* Class Description of the generic product
......... @id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
......... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
......... intendedName 0..1 ST Name of prescribed product
Example Example: chloorfenamine + paracetamol oraal 3,2 mg + 240 mg
......... intendedCd 0..1 CD Code of prescribed product (VMPGROUP or CNK)
......... deliveredName 0..1 ST Name of delivered product
......... deliveredCd 0..1 CD Code of delivered product (CNK)
........ compoundprescription 0..* Class Description of the compound product
......... @id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
......... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
......... magistraltext 1..1 ST Recipe of the prescription
Example Example: R/ Aluminiumchloride hexahydraat 15 g + Isopropylalcohol 78 g + Gezuiverd water q.s. ad 100 g T
....... content 0..* string Extra content field which can be added if neccessary
....... text 0..* string Mandatory if compoundprescription is used

Example Example: Aluminiumchloride transpiratieremmende hydroalcoholische oplossing 15 % TMF
....... temporality 0..* Class The temporality
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ cd 0..1 string Coded value
....... frequency 0..* Class To Do
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ periodicity 0..* Class To Do
......... @id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
......... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
......... cd 0..* ANY S-VALUE=CD-PERIODICITY
....... posology 0..* Class The freetext posology is mutual exclusive with the structured Regimen
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ text 1..1 string Contains the ingestion pattern in textual form
Example Example: tot 4 x per dag 1 tablet
....... regimen 0..* Class To Do
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ date 0..* date date, mostly used icw periodicity=monthly or at a specifiec time of the day
........ weekday 0..* integer Day of the week, mostly used icw periodicity=weekly
......... @id 0..1 string xml:id (or equivalent in JSON)
......... extension 0..* Extension Additional content defined by implementations
......... @value 0..1 integer Primitive value for integer
......... cd 1..1 string the day of the week
Example Example: monday
........ daynumber 0..* integer Daynumber, mostly used icw periodicity=weekly or daily
........ daytime 0..* Class indication of the intake moment
......... @id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
......... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
......... time 1..1 date The time when the line was registered in the schema
......... dayperiod 1..* Class mutual exclusive with <time>
.......... @id 0..1 string Unique id for inter-element referencing
.......... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.......... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.......... cd 0..* string Coded value
........ quantity 1..1 Class To Do
......... @id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
......... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
......... decimal 0..* integer the amount, expressed in a number
......... unit 0..* Class the prescribed administration unit where the decimal applies to
.......... @id 0..1 string Unique id for inter-element referencing
.......... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.......... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.......... cd 0..* string To Do
....... route 0..* Class The drug administration route
........ @id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ cd 0..* ANY To Do
....... instructionforpatient 0..1 string Usage instructions for the patient.
Example Example: A diminuer si possible

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel