Back To Index  <<  Back To Templates

retired Template  epSOS CDA Material

Id 2.16.840.1.113883.3.1937.777.11.10.143 Effective Date 2013‑12‑20
Other versions this id:
Status retired Retired Version Label
Name epSOSCDAMaterial Display Name epSOS CDA Material
Classification CDA Entry Level Template
Open/Closed Open (other than defined elements are allowed)
Associated with
Associated with 7 concepts
Id Name Data Set
epsos-dataelement-105 draft Strength draft epSOS Data Set
epsos-dataelement-137 draft Brand name draft epSOS Data Set
epsos-dataelement-135 draft Medicinal product code draft epSOS Data Set
epsos-dataelement-106 draft Pharmaceutical dose form draft epSOS Data Set
epsos-dataelement-104 draft Active ingredient code draft epSOS Data Set
epsos-dataelement-103 draft Active ingredient draft epSOS Data Set
epsos-dataelement-138 draft Medicinal product package size draft epSOS Data Set
Relationship Generalization: template 2.16.840.1.113883.10.12.311 CDA Material (2005‑09‑07)
ref
ad1bbr-
notice There are open issues with this item:
  • epsos-issue-187: units in ingredient/quantity (Feedback needed)
  • epsos-issue-248: hl7:name cardinality must be changed from 0 ... 1 to 1 ... 1 (Open)
  • epsos-issue-272: restrict formCode CONF to epSOSPackage value set for asContent part (Open)
Item DT Card Conf Description Label
hl7:manufacturedMaterial
0 … * R (epSdotsial)
@classCode
cs 1 … 1 F MMAT
@determinerCode
cs 1 … 1 F KIND
hl7:code
CE.EPSOS 0 … 1 R The <code> element of the <manufacturedMaterial> describes the medication.
For the scope of epSOS this is used to convey the “Country A Cross-border/regional/national medicinal product code.

In a CDA document, the <originalText> shall contain a <reference> whose URI value points to the generic name and strength of the medication in the narrative, or just the generic name alone if strength is not relevant.

Note: When the text is supplied from the narrative, the implication is that if the components of a combination medication are supplied in an entry, these must also be displayed in narrative text; the combination medication will not be able to be broken down into its component parts. This is entirely consistent with the CDA Release 2.0 requirements that the narrative supply the necessary and relevant human readable information content.
(epSdotsial)
 
target
epsos-dataelement-135 draft Medicinal product code draft epSOS Data Set
hl7:name
EN 0 … 1 R In an epSOS ePrescriprion or eDispensation document, the element should contain the brand name of the medication. (epSdotsial)
 
target
epsos-dataelement-137 draft Brand name draft epSOS Data Set
epsos:desc
EN 0 … 1 R Free-text representation of the strength. (epSdotsial)
  Example <epsos:desc>20/12,5 mg</epsos:desc>
epsos:formCode
CE.EPSOS 1 … 1 R This code represents the form of the medication (e.g. tablet, capsule, liquid). The value of this code affects the units used in the substance administration quantity element – if the form is a tablet, for example, the unit is 1; if the form is a liquid, the unit will be part of UCUM. The value set is epSOSDoseForm, OID: 1.3.6.1.4.1.12559.11.10.1.3.1.42.2.
(epSdotsial)
 
target
epsos-dataelement-106 draft Pharmaceutical dose form draft epSOS Data Set
  CONF
The value of @code shall be drawn from value set 1.3.6.1.4.1.12559.11.10.1.3.1.42.2 eHDSIDoseForm (DYNAMIC)
  Example <epsos:formCode code="10211000" codeSystem="0.4.0.127.0.16.1.1.2.1" codeSystemName="EDQM" codeSystemVersion="2017-04-14" displayName="Capsule, soft">...</epsos:formCode>
epsos:asContent
0 … * R This structure describes the packaging of the medication. The element provides the code for the particular package. If the package has a brand name, it can be described in the element. The element described the capacity of the packaging. For example, to represent 30 tablets, the element at the level must indicate tablets as the form, value attribute of the element must have the value of 30, and the unit attribute must be 1. In the cases where the unit attribute is not 1, UCUM units shall be used. The value set is epSOSUnits, OID 1.3.6.1.4.1.12559.11.10.1.3.1.42.16 and epSOSDoseForm, OID 1.3.6.1.4.1.12559.11.10.1.3.1.42.2. (epSdotsial)
@classCode
cs 1 … 1 F CONT
  Example <epsos:asContent classCode="CONT">
  <epsos:containerPackagedMedicine classCode="CONT" determinerCode="INSTANCE">
    <epsos:name/>    <epsos:formCode code=" " displayName=" " codeSystem=" " codeSystemName=" "/>    <epsos:capacityQuantity value=" " unit=" "/>  </epsos:containerPackagedMedicine>
</epsos:asContent>
epsos:containerPackagedMedicine
1 … * R (epSdotsial)
@classCode
cs 1 … 1 F CONT
@determinerCode
cs 1 … 1 F INSTANCE
  Example <epsos:containerPackagedMedicine classCode="CONT" determinerCode="INSTANCE">...</epsos:containerPackagedMedicine>
epsos:name
ST 0 … * R (epSdotsial)
  Example <epsos:name>...</epsos:name>
epsos:formCode
CE.EPSOS 1 … 1 R (epSdotsial)
  CONF
The value of @code shall be drawn from value set 1.3.6.1.4.1.12559.11.10.1.3.1.42.2 eHDSIDoseForm (DYNAMIC)
or
The value of @code shall be drawn from value set 1.3.6.1.4.1.12559.11.10.1.3.1.42.3 eHDSIPackage (DYNAMIC)
  Example <epsos:formCode code="10100500" codeSystem="0.4.0.127.0.16.1.1.2.1" displayName="Concentrate for oral suspension"/>
epsos:capacityQuantity
PQ 1 … 1 M (epSdotsial)
 
target
epsos-dataelement-138 draft Medicinal product package size draft epSOS Data Set
@unit
cs 1 … 1 R
  CONF
The value of @unit shall be drawn from value set 1.3.6.1.4.1.12559.11.10.1.3.1.42.16 eHDSIUnit (DYNAMIC)
@value
1 … 1 R
  Example <epsos:capacityQuantity unit="1" value="700"/>
epsos:asSpecializedKind
0 … 1 R This module is used for representing the classification of the Substance according to the WHO Anatomical Therapeutic Chemical (ATC) Classification System. 

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

The <epsos:code> element contains the ATC code, and the <epsos:name> element may be used for the plain text representation.

(epSdotsial)
@classCode
cs 1 … 1 F GEN
  Example <epsos:asSpecializedKind classCode="GEN">
  <epsos:generalizedMedicineClass classCode="MMAT">
    <epsos:code code=" " codeSystem="2.16.840.1.113883.6.73" codeSystemName="Anatomical Therapeutic Chemical" displayName=" "/>    <epsos:name/>  </epsos:generalizedMedicineClass>
</epsos:asSpecializedKind>
epsos:generalizedMedicineClass
R (epSdotsial)
@classCode
cs 1 … 1 F MMAT
epsos:code
CD.EPSOS 1 … 1 R (epSdotsial)
  CONF
The value of @code shall be drawn from value set 1.3.6.1.4.1.12559.11.10.1.3.1.42.24 eHDSIActiveIngredient (DYNAMIC)
epsos:name
0 … 1 (epSdotsial)
epsos:ingredient
0 … * R One or more active ingredients may be represented with this structure. The classCode of "ACTI" indicates that this is an active ingredient. The element contains the coded representation of the ingredient and the element may be used for the plain text representation. (epSdotsial)
@classCode
cs 1 … 1 F ACTI
@determinerCode
cs 1 … 1 F KIND
  Example <epsos:ingredient classCode="ACTI">...</epsos:ingredient>
epsos:quantity
1 … 1 M 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. (epSdotsial)
 
target
epsos-dataelement-105 draft Strength draft epSOS Data Set
  Example <epsos:quantity>...</epsos:quantity>
epsos:numerator
epsos:PQ 1 … 1 R (epSdotsial)
@unit
cs 1 … 1 R
@value
1 … 1 R
  Example <epsos:numerator unit="mg" value="20" xsi:type="epsos:PQ"/>
epsos:denominator
epsos:PQ 1 … 1 R (epSdotsial)
@unit
cs 1 … 1 R
@value
1 … 1 R
  Example <epsos:denominator unit="1" value="1" xsi:type="epsos:PQ"/>
epsos:ingredient
CD.EPSOS 1 … 1 R (epSdotsial)
epsos:code
CD.EPSOS 1 … 1 R (epSdotsial)
 
target
epsos-dataelement-104 draft Active ingredient code draft epSOS Data Set
  CONF
The value of @code shall be drawn from value set 1.3.6.1.4.1.12559.11.10.1.3.1.42.24 eHDSIActiveIngredient (DYNAMIC)
epsos:originalText
ED 0 … * (epSdotsial)
epsos:reference
TEL 0 … * (epSdotsial)
epsos:translation
CD 0 … * This element can be used to provide alternative identifications for the described substance. (epSdotsial)
epsos:name
0 … 1 Name of the substance (epSdotsial)
 
target
epsos-dataelement-103 draft Active ingredient draft epSOS Data Set