Medication Time Units (UCUM)

Medication Time Units (UCUM)

If the statement refers to a prescribed medication then a intent (moodCode='INT') is used; otherwise, to record medications which are stated to have taken, the moodCode shall be set to 'EVN'.

MoodCodeEvnInt

The <code> element is valorized with the Substance Administration ACT code "DRUG" unless it is used for asserting the  known absence of medication treatments or no information about them.

IPS No Medications

The URI given in the value attribute of the <reference> element points to an element in the narrative content that contains the complete text describing the medication.

In a CDA document, the URI given in the value attribute of the <reference> element points to an element in the narrative content that contains the complete text describing the medication.

Reference pointing to the narrative, typically #{label}-{generated-id}, e.g. #xxx-1

ActStatusActiveCompletedAbortedSuspended

The <routeCode> element specifies the route of administration using the EDQM route of administration vocabulary.

A code must be specified if the route is known. 

Since the EDQM Standards Terms, together with UCUM, is one of the IDMP terminologies actually available for usage, this code system has been selected  as referecne terminology for representing Pharmaceutical Dose forms; Packages and Route of Administration.

It is known that also alternative jurisdictional and international terminologies are also used for this concept domain, as NCI or SNOMED CT.

Official NCI and EDQM maps for the route of administration are available from the EDQM site.

IPS Medicine Route of Administration

This element is supposed to be valorized with the complete Medicinal Product Name as approved by the Medicines Regulatory Agency in a jurisdiction.

The name may be applicable in one or more country/language combinations.

Administrable Pharmaceutical Dose Form.

This code represents the form of the medication (e.g. tablet, capsule, liquid)

Since the EDQM Standards Terms, together with UCUM, is one of the IDMP terminologies actually available for usage, this code system has been selected  as referecne terminology for representing Pharmaceutical Dose forms;Pakages and Route of Administration.

It is known that also alternative jurisdictional and international terminologies are known to be used for this concept domain, as NCI or SNOMED CT.

IPS Medicine Doseform

This structure describes the packaging of the medication.

​The pharm:formCode element provides the code for the particular package.

​If the package has a brand name, it can be described in the pharm:name element.

​The pharm:capacityQuantity element describes the capacity of the packaging, while the pharm:quantity the actual quantity of inner packaged items in the outer packaging container. The product might have a single (30 pills bottle) or multiple (5 vials 10 ml; box with 2 blisters of 20 tablets) layers of packaging.

In the latter case, the most inner (nested) item represents the most outer package item.

For example the case 

  --Box 

  -----2 blisters 

  --------20 tablets 

is described as "20 tablets" contained by "a blister"; "2 blisters" contained by one box.

The most inner package represents the Packaged Medicinal Product.

When the IDMP Packaged Medicinal Product ID (PCID) will become actually available for usage, the most inner package <code> element will be used to convey the IDMP PCID.

The quantity which specified how many inner packaged content entities are in an outer packaging container entity.

Quantity Units

It represents the most inner Package Item or the Packaged Medicinal Product.

​If this is also the most outer pharm:containerPackagedProduct than the <code> element can be used to convey the (IDMP) Packaged Medicinal Product ID (e.g. the IDMP PCID when it will become actually available for usage).  

The presence of the PCID indicates that that element represents the "Packaged Medicinal Product".

It represents the Name of the Package Item or of the Packaged Medicinal Product.

​If this is also the most outer pharm:containerPackagedProduct than this element can be used for the brand name.

This element encodes the type of the most inner package item or of the or the Packaged Medicinal Product.

Since the EDQM Standards Terms, together with UCUM, is one of the IDMP terminologies actually available for usage, this code system has been selected  as referecne terminology for representing Pharmaceutical Dose forms; Packages and Route of Administration.

Medicine Package

It represents the functional capacity of the container: e.g. bottle containing up to 20 tablets or ampule of 10 ml.

Quantity Units

In case of multiple layers of packaging (5 vials 10 ml; box with 2 blisters of 20 tablets) this element can be used for describing the intermediate Packaged Medicinal Product Item or the Packaged Medicinal Product.

For example in the case 

  --Box 

  -----2 blisters 

  --------20 tablets 

it describes the "2 blisters" 

In the case of 

  --Box 

  -----5 vials

it represents the Packaged Medicinal Product. 

The quantity which specified how many inner packaged content entities are in an outer packaging container entity.

Quantity Units

It represents the intermediate Package Item or the Packaged Medicinal Product

​If this is also the most inner  pharm:containerPackagedProduct than the <code> element can be used to convey the (IDMP) Packaged Medicinal Product ID (e.g. the IDMP PCID when it will become actually available for usage).  

The presence of the PCID indicates that that element represents the "Packaged Medicinal Product".

It represents the Name of the Package Item or of the Packaged Medicinal Product

​If this is also the most inner  pharm:containerPackagedProduct than this element can be used for the brand name.

This element encodes the type of the most inner package item or of the or the Packaged Medicinal Product.

Since the EDQM Standards Terms, together with UCUM, is one of the IDMP terminologies actually available for usage, this code system has been selected  as reference terminology for representing Pharmaceutical Dose forms; Packages and Route of Administration.

Medicine Package

It represents the functional capacity of the container: e.g. bottle containing up to 20 tablets or ampule of 10 ml.

Quantity Units

In case of multiple layers of packaging (box with 2 blisters of 20 tablets) this element is used for describing the most outer Packaged Medicinal Product Item or the Packaged Medicinal Product.

For example in the case 

  --Box 

  -----2 blisters 

  --------20 tablets 

it describes the Packaged Medicinal Product. 

The quantity which specified how many inner packaged content entities are in an outer packaging container entity.

Quantity Units

When present, it represents the Packaged Medicinal Product

When present, it can be used to convey the (IDMP) Packaged Medicinal Product ID (e.g. the IDMP PCID when it will become actually available for usage).

When present, it can be used for the representing the brand name.

When present, it encodes the type of the outer package.

Since the EDQM Standards Terms, together with UCUM, is one of the IDMP terminologies actually available for usage, this code system has been selected  as referecne terminology for representing Pharmaceutical Dose forms; Packages and Route of Administration.

Medicine Package

It represents the functional capacity of the container: e.g. bottle containing up to 20 tablets or ampule of 10 ml.

Quantity Units

This module is used for representing the classification of the Substance according to the WHO Anatomical Therapeutic Chemical (ATC) Classification System.

The classCode of "GRIC" identifies this structure as the representation of a generic equivalent of the medication described in the current Medicine entry.

The <code> element contains the ATC code of this medicine.

WHO ATC

The Medicinal Product can be classified according to various classification systems, which may be jurisdictional or international. The classification system itself is specified using an appropriate identification system; the controlled term and the controlled term identifier shall be specified.

When the IDMP Pharmaceutical Product Identifier(s) (PhPID Set) will become actually available for use, the PhPID will be represented by the generalizedMaterialKind/code element.

When the IDMP Pharmaceutical Product Identifier(s) (PhPID Set) will become actually available for use, this element will be used for representing the IDMP PhP Id.

The level and the stratum of the PhPID will be distiguished by the OID of the code system.

This module provides the list of the ingredients (substances with a role) used for this product; one or more ingredients may be present.

The classCode of "ACTI" indicates that this is an active ingredient.

RoleClassIngredientEntity

The medication strength is represented as the ratio of the active ingredient(s) to a unit of medication. The element contains the numerator and denominator of the strength ratio.

Medicine Strength Numerator

Medicine Strength Denominator

The IDMP ISO 11238 standard addresses the identification and exchange of regulated information on substances.  The Global Ingredient Archival System (GInAS)  will provide a common global identifier for all of the substances used in medicinal products, providing a definition of substances globally consistent with this standard. Those identifiers however are yet available for concrete usage, therefore in this version of the template, SNOMED CT has been chosen as reference terminology also for the active substances. This choice will be revised based on the availability and the maturity of GInAS.

IPS Medicine Active Substances

This element can be used to provide alternative identifications for the described substance.

Name of the substance

Name of the person (e.g. the Healthcare Professional)  authoring this document

Subordinate Substance Administration Statement as a component of the overall medication statement.

Unless medications are unknown or known absent, at least one subordinated <substanceAdministration> has to be present to convey information about dosages (dose, frequency of intakes,..).

Subordinated <substanceAdministration> elements can be also used either to handle split dosing, or to support combination medications.At least one subordinate  element SHALL be present unless medications are unknown or known absent.

Sequence number of the Subordinate Substance Administration

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.

If the statement refers to a prescribed medication then a intent (moodCode='INT') is used; otherwise, to record medications which are stated to have taken, the moodCode shall be set to 'EVN'.

MoodCodeEvnInt

The <code> element is valorized with the Substance Administration ACT code "DRUG" unless it is used for asserting the  known absence of medication treatments or no information about them.

IPS No Medications

The URI given in the value attribute of the <reference> element points to an element in the narrative content that contains the complete text describing the medication.

In a CDA document, the URI given in the value attribute of the <reference> element points to an element in the narrative content that contains the complete text describing the medication.

A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data.

Reference pointing to the narrative, typically #{label}-{generated-id}, e.g. #xxx-1

ActStatusActiveCompletedAbortedSuspended

The <routeCode> element specifies the route of administration using the EDQM route of administration vocabulary.

A code must be specified if the route is known. 

Since the EDQM Standards Terms, together with UCUM, is one of the IDMP terminologies actually available for usage, this code system has been selected  as referecne terminology for representing Pharmaceutical Dose forms; Packages and Route of Administration.

It is known that also alternative jurisdictional and international terminologies are also used for this concept domain, as NCI or SNOMED CT.

Official NCI and EDQM maps for the route of administration are available from the EDQM site.

IPS Medicine Route of Administration

The consumable participation is used to bring in the LabeledDrug or Material entity that describes the administered substance. The LabeledDrug class, which is an Entity class playing the Role of Manufactured Product, identifies the drug that is consumed in the substance administration. The medication is identified by means of the LabeledDrug.code or the LabeledDrug.name. The Material entity is used to identify non-drug administered substances such as vaccines and blood products.

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.

This element is supposed to be valorized with the complete Medicinal Product Name as approved by the Medicines Regulatory Agency in a jurisdiction.

The name may be applicable in one or more country/language combinations.

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.

Subordinate Substance Administration Statement as a component of the overall medication statement.

Unless medications are unknown or known absent, at least one subordinated <substanceAdministration> has to be present to convey information about dosages (dose, frequency of intakes,..).

Subordinated <substanceAdministration> elements can be also used either to handle split dosing, or to support combination medications.At least one subordinate  element SHALL be present unless medications are unknown or known absent.

Sequence number of the Subordinate Substance Administration

The moodCode of this subordinate substance administration SHALL be the same of the parent substance administration

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question

When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.

Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).

Identifies the type as an HL7 Registered model

A character string as a unique identifier within the scope of the identifier root.

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.

Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).

A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.

A character string as a unique identifier within the scope of the identifier root.

If the statement refers to a prescribed medication then a intent (moodCode='INT') is used; otherwise, to record medications which are stated to have taken, the moodCode shall be set to 'EVN'.

MoodCodeEvnInt

The <code> element is valorized with the Substance Administration ACT code "DRUG" unless it is used for asserting the  known absence of medication treatments or no information about them.

IPS No Medications

The URI given in the value attribute of the <reference> element points to an element in the narrative content that contains the complete text describing the medication.

In a CDA document, the URI given in the value attribute of the <reference> element points to an element in the narrative content that contains the complete text describing the medication.

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Indicates whether the raw byte data is compressed, and what compression algorithm was used.

The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created.

Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage.

For character based information the language property specifies the human language of the text.

Identifies the type of the encapsulated data and identifies a method to interpret or render the data.

Data that is primarily intended for human interpretation or for further machine processing is outside the scope of HL7. This includes unformatted or formatted written language, multimedia data, or structured information as defined by a different standard (e.g., XML-signatures.)

This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data.

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Reference pointing to the narrative, typically #{label}-{generated-id}, e.g. #xxx-1

Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address.

One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.

An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference.

ActStatusActiveCompletedAbortedSuspended

The <routeCode> element specifies the route of administration using the EDQM route of administration vocabulary.

A code must be specified if the route is known. 

Since the EDQM Standards Terms, together with UCUM, is one of the IDMP terminologies actually available for usage, this code system has been selected  as referecne terminology for representing Pharmaceutical Dose forms; Packages and Route of Administration.

It is known that also alternative jurisdictional and international terminologies are also used for this concept domain, as NCI or SNOMED CT.

Official NCI and EDQM maps for the route of administration are available from the EDQM site.

IPS Medicine Route of Administration

The consumable participation is used to bring in the LabeledDrug or Material entity that describes the administered substance. The LabeledDrug class, which is an Entity class playing the Role of Manufactured Product, identifies the drug that is consumed in the substance administration. The medication is identified by means of the LabeledDrug.code or the LabeledDrug.name. The Material entity is used to identify non-drug administered substances such as vaccines and blood products.

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question

When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.

Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).

Identifies the type as an HL7 Registered model

A character string as a unique identifier within the scope of the identifier root.

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question

When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.

Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).

Identifies the type as an HL7 Registered model

A character string as a unique identifier within the scope of the identifier root.

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.

Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).

A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.

A character string as a unique identifier within the scope of the identifier root.

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question

When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.

Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).

Identifies the type as an HL7 Registered model

A character string as a unique identifier within the scope of the identifier root.