Id2.16.840.1.113883.3.1937.777.11.10.100Effective Date2013‑12‑20
Statusdraft DraftVersion Label
NameepSOSCDArecordTargetDisplay NameepSOS CDA recordTarget
ClassificationCDA Header Level Template
Open/ClosedOpen (other than defined elements are allowed)
Associated with
Associated with 28 concepts
IdNameData Set
epsos-dataelement-26draft Contact Information draft epSOS Data Set
epsos-dataelement-263draft Prefix draft epSOS Data Set
epsos-dataelement-51draft Street draft epSOS Data Set
epsos-dataelement-235draft Other Identifier draft epSOS Data Set
epsos-dataelement-28draft Telephone No draft epSOS Data Set
epsos-dataelement-13draft Family Name/Surname draft epSOS Data Set
epsos-dataelement-39draft Telephone No draft epSOS Data Set
epsos-dataelement-38draft Family Name/Surname draft epSOS Data Set
epsos-dataelement-27draft Address draft epSOS Data Set
epsos-dataelement-10draft Date of Birth draft epSOS Data Set
epsos-dataelement-54draft Country draft epSOS Data Set
epsos-dataelement-11draft Gender draft epSOS Data Set
epsos-dataelement-8draft Personal Information draft epSOS Data Set
epsos-dataelement-55draft City draft epSOS Data Set
epsos-dataelement-7draft National Health Care patient ID (country of affiliation) draft epSOS Data Set
epsos-dataelement-53draft Postal Code draft epSOS Data Set
epsos-dataelement-12draft Given name draft epSOS Data Set
epsos-dataelement-5draft Patient Data draft epSOS Data Set
epsos-dataelement-234draft National Health Care patient ID (country of treatment) draft epSOS Data Set
epsos-dataelement-52draft Number of Street draft epSOS Data Set
epsos-dataelement-300draft Telecom draft epSOS Data Set
epsos-dataelement-37draft Given Name draft epSOS Data Set
epsos-dataelement-29draft Email draft epSOS Data Set
epsos-dataelement-56draft State or Province draft epSOS Data Set
epsos-dataelement-6draft Identification draft epSOS Data Set
epsos-dataelement-34draft Contact Person/legal guardian draft epSOS Data Set
epsos-dataelement-9draft Full Name draft epSOS Data Set
epsos-dataelement-36draft Full Name draft epSOS Data Set
Used by / Uses
Used by 16 transactions and 59 templates, Uses 0 templates
Used by as NameVersion
2.16.840.1.113883.3.1937.777.11.4.23Transactiondraft Return MRO2013‑11‑02
2.16.840.1.113883.3.1937.777.11.4.29Transactiondraft Return PS (PDF embedded) of country A2017‑11‑20 18:28:16
2.16.840.1.113883.3.1937.777.11.4.12Transactiondraft Return PS of country A2012‑05‑02
2.16.840.1.113883.3.1937.777.11.4.32Transactiondraft Return eP(PDF embedded) from country A2017‑11‑21 10:26:49
2.16.840.1.113883.3.1937.777.11.4.41Transactiondraft Return OrCD Medical Images of country A2021‑04‑30 11:16:15
2.16.840.1.113883.3.1937.777.11.4.19Transactiondraft Return eP from country A2013‑11‑02
2.16.840.1.113883.3.1937.777.11.4.21Transactiondraft Send HCER to country A2013‑11‑02
2.16.840.1.113883.3.1937.777.11.4.35Transactiondraft Return OrCD Hospital Discharge Report of country A2021‑04‑30 09:22:38
2.16.840.1.113883.3.1937.777.78.4.6Transactiondraft ePrescription (PDF embedded)2024‑01‑18
2.16.840.1.113883.3.1937.777.78.4.2Transactiondraft Send eD2024‑01‑18
2.16.840.1.113883.3.1937.777.11.4.25Transactiondraft Send eD to country A2013‑11‑02
2.16.840.1.113883.3.1937.777.78.4.10Transactiondraft Patient Summary (PDF embedded)2024‑01‑18
2.16.840.1.113883.3.1937.777.78.4.4Transactiondraft ePrescription2024‑01‑18
2.16.840.1.113883.3.1937.777.11.4.44Transactiondraft Return OrCD Medical Imaging Report of country A2021‑04‑30 11:27:45
2.16.840.1.113883.3.1937.777.78.4.8Transactiondraft Patient summary2024‑01‑18
2.16.840.1.113883.3.1937.777.11.4.38Transactiondraft Return OrCD Laboratory Result of country A2021‑04‑30 11:00:04
1.3.6.1.4.1.12559.11.10.1.3.1.1.1Includedraft epSOS-ePrescription2013‑12‑20
1.3.6.1.4.1.12559.11.10.1.3.1.1.1Includeretired epSOS-ePrescription2018‑11‑14 10:49:44
1.3.6.1.4.1.12559.11.10.1.3.1.1.1Includeretired eHDSI ePrescription2020‑04‑16 10:42:14
1.3.6.1.4.1.12559.11.10.1.3.1.1.1Includeretired eHDSI ePrescription2020‑06‑17 09:25:30
1.3.6.1.4.1.12559.11.10.1.3.1.1.1Includeretired eHDSI ePrescription2020‑09‑09 12:19:36
1.3.6.1.4.1.12559.11.10.1.3.1.1.1Includeretired eHDSI ePrescription2020‑09‑09 12:22:47
1.3.6.1.4.1.12559.11.10.1.3.1.1.1Includeretired eHDSI ePrescription2022‑09‑12 13:39:27
1.3.6.1.4.1.12559.11.10.1.3.1.1.1Includeactive eHDSI ePrescription2024‑04‑19 09:57:14
1.3.6.1.4.1.12559.11.10.1.3.1.1.2Includedraft epSOS-eDispensation2013‑12‑20
1.3.6.1.4.1.12559.11.10.1.3.1.1.2Includeretired epSOS-eDispensation2018‑11‑14 10:49:04
1.3.6.1.4.1.12559.11.10.1.3.1.1.2Includeretired epSOS-eDispensation2019‑11‑11 14:43:22
1.3.6.1.4.1.12559.11.10.1.3.1.1.2Includeretired epSOS-eDispensation2020‑04‑06 19:20:14
1.3.6.1.4.1.12559.11.10.1.3.1.1.2Includeretired eHDSI eDispensation2020‑04‑16 10:41:22
1.3.6.1.4.1.12559.11.10.1.3.1.1.2Includeretired eHDSI eDispensation2020‑08‑31 08:12:35
1.3.6.1.4.1.12559.11.10.1.3.1.1.2Includeretired eHDSI eDispensation2020‑09‑09 12:09:23
1.3.6.1.4.1.12559.11.10.1.3.1.1.2Includeretired eHDSI eDispensation2022‑09‑12 13:38:46
1.3.6.1.4.1.12559.11.10.1.3.1.1.2Includeactive eHDSI eDispensation2024‑04‑19 09:56:20
1.3.6.1.4.1.12559.11.10.1.3.1.1.3Includedraft epSOS-Patient Summary2013‑12‑20
1.3.6.1.4.1.12559.11.10.1.3.1.1.3Includeretired epSOS-Patient Summary2018‑11‑14 10:53:50
1.3.6.1.4.1.12559.11.10.1.3.1.1.3Includeretired eHDSI Patient Summary2020‑04‑14 13:03:47
1.3.6.1.4.1.12559.11.10.1.3.1.1.3Includeretired eHDSI Patient Summary2020‑09‑02 10:19:44
1.3.6.1.4.1.12559.11.10.1.3.1.1.3Includeretired eHDSI Patient Summary2022‑09‑12 13:44:19
1.3.6.1.4.1.12559.11.10.1.3.1.1.3Includeactive eHDSI Patient Summary2024‑04‑19 10:03:32
1.3.6.1.4.1.12559.11.10.1.3.1.1.4Includedraft epSOS-Health Care Encounter Report2013‑12‑20
1.3.6.1.4.1.12559.11.10.1.3.1.1.4Includeretired epSOS-Health Care Encounter Report2018‑11‑14 09:02:41
1.3.6.1.4.1.12559.11.10.1.3.1.1.5Includedraft epSOS-Medication Related Overview2013‑12‑20
1.3.6.1.4.1.12559.11.10.1.3.1.1.5Includeretired epSOS-Medication Related Overview2018‑11‑14 09:03:13
1.3.6.1.4.1.12559.11.10.1.3.1.1.6Includedraft eHDSI-ePrescription PDF embedded2017‑03‑11 22:32:59
1.3.6.1.4.1.12559.11.10.1.3.1.1.6Includeretired eHDSI-ePrescription PDF embedded2018‑11‑14 09:01:05
1.3.6.1.4.1.12559.11.10.1.3.1.1.6Includeretired eHDSI ePrescription PDF embedded2020‑04‑16 10:39:54
1.3.6.1.4.1.12559.11.10.1.3.1.1.6Includeretired eHDSI ePrescription PDF embedded2020‑06‑17 09:27:29
1.3.6.1.4.1.12559.11.10.1.3.1.1.6Includeretired eHDSI ePrescription PDF embedded2020‑09‑09 12:25:17
1.3.6.1.4.1.12559.11.10.1.3.1.1.6Includeretired eHDSI ePrescription PDF embedded2022‑09‑12 13:39:56
1.3.6.1.4.1.12559.11.10.1.3.1.1.6Includeactive eHDSI ePrescription PDF embedded2024‑04‑19 09:58:04
1.3.6.1.4.1.12559.11.10.1.3.1.1.7Includedraft eHDSI-Patient Summary PDF embedded2017‑03‑11 18:41:31
1.3.6.1.4.1.12559.11.10.1.3.1.1.7Includeretired eHDSI-Patient Summary PDF embedded2018‑11‑14 09:01:49
1.3.6.1.4.1.12559.11.10.1.3.1.1.7Includeretired eHDSI Patient Summary PDF embedded2020‑04‑14 13:05:42
1.3.6.1.4.1.12559.11.10.1.3.1.1.7Includeretired eHDSI Patient Summary PDF embedded2020‑09‑09 12:49:26
1.3.6.1.4.1.12559.11.10.1.3.1.1.7Includeretired eHDSI Patient Summary PDF embedded2022‑09‑12 13:45:01
1.3.6.1.4.1.12559.11.10.1.3.1.1.7Includeactive eHDSI Patient Summary PDF embedded2024‑04‑19 10:04:07
1.3.6.1.4.1.12559.11.10.1.3.1.1.8Includeretired eHDSI OrCD Laboratory Result2020‑11‑27 14:52:00
1.3.6.1.4.1.12559.11.10.1.3.1.1.8Includeretired eHDSI OrCD Laboratory Result2022‑09‑12 13:40:54
1.3.6.1.4.1.12559.11.10.1.3.1.1.8Includeactive eHDSI OrCD Laboratory Result2024‑04‑19 10:00:48
1.3.6.1.4.1.12559.11.10.1.3.1.1.9Includeretired eHDSI OrCD Hospital Discharge Report2020‑11‑30 15:46:00
1.3.6.1.4.1.12559.11.10.1.3.1.1.9Includeretired eHDSI OrCD Hospital Discharge Report2022‑09‑12 13:40:30
1.3.6.1.4.1.12559.11.10.1.3.1.1.9Includeactive eHDSI OrCD Hospital Discharge Report2024‑04‑19 10:00:12
1.3.6.1.4.1.12559.11.10.1.3.1.1.10Includeretired eHDSI OrCD Medical Imaging Report2020‑11‑30 16:12:00
1.3.6.1.4.1.12559.11.10.1.3.1.1.10Includeretired eHDSI OrCD Medical Imaging Report2022‑09‑12 13:42:07
1.3.6.1.4.1.12559.11.10.1.3.1.1.10Includeactive eHDSI OrCD Medical Imaging Report2024‑04‑19 10:02:57
1.3.6.1.4.1.12559.11.10.1.3.1.1.11Includeretired eHDSI OrCD Medical Images2021‑01‑18 16:22:00
1.3.6.1.4.1.12559.11.10.1.3.1.1.11Includeretired eHDSI OrCD Medical Images2022‑09‑12 13:41:33
1.3.6.1.4.1.12559.11.10.1.3.1.1.11Includeactive eHDSI OrCD Medical Images2024‑04‑19 10:02:27
2.16.840.1.113883.3.1937.777.78.10.1Includeactive UNICOM eDispensation (v0.1)2024‑01‑18 11:51:57
2.16.840.1.113883.3.1937.777.78.10.2Includeretired eHDSI ePrescription (v0.1)2024‑01‑18 11:53:34
2.16.840.1.113883.3.1937.777.78.10.3Includeactive UNICOM ePrescription (v0.1)2024‑01‑18 11:55:30
2.16.840.1.113883.3.1937.777.78.10.4Includeactive UNICOM Patient Summary PDF embedded (v0.1)2024‑01‑18 11:56:32
2.16.840.1.113883.3.1937.777.78.10.5Includeactive UNICOM Patient Summary (v0.1)2024‑01‑18 11:57:06
2.16.840.1.113883.3.1937.777.78.10.6Includeactive UNICOM ePrescription PDF embedded (v0.1)2024‑01‑18 11:59:07
2.16.840.1.113883.3.1937.777.78.10.7Includecancelled UNICOM eDispensation (v0.1)2024‑01‑23 10:02:49
RelationshipSpecialization: template 2.16.840.1.113883.10.12.101 CDA recordTarget (2005‑09‑07)
ref
ad1bbr-
ItemDTCardConfDescriptionLabel
hl7:recordTarget
1 … *RepSOdotsrget
 
target
epsos-dataelement-5draft Patient Data draft epSOS Data Set
@typeCode
cs0 … 1FRCT
@contextControlCode
cs0 … 1FOP
hl7:patientRole
1 … 1MepSOdotsrget
 
target
epsos-dataelement-26draft Contact Information draft epSOS Data Set
@classCode
cs0 … 1FPAT
hl7:id
II.EPSOS1 … *RPatient Identifiers: Primary Patient Identifier (Regional/National Health Id), Secondary Patient Identifier (Social/Insurance Number)R1.4 / R1.4.1 / R1.4.2
 
target
epsos-dataelement-235draft Other Identifier draft epSOS Data Set
epsos-dataelement-7draft National Health Care patient ID (country of affiliation) draft epSOS Data Set
epsos-dataelement-234draft National Health Care patient ID (country of treatment) draft epSOS Data Set
epsos-dataelement-6draft Identification draft epSOS Data Set
hl7:addr
AD.EPSOS1 … 1RThe patient address element is required. If there is no information, the nullFlavor attribute shall have a value of 'NI' and no address parts shall be present, otherwise there shall be no nullFlavor attribute, and at least one of the address parts listed below shall be present.R1.5
 
target
epsos-dataelement-27draft Address draft epSOS Data Set
@nullFlavor
cs0 … 1FNI
hl7:streetAddressLine
0 … *RPatient's Number of Street/Patient's Number of StreetR1.5.1 / R1.5.2
 
target
epsos-dataelement-51draft Street draft epSOS Data Set
epsos-dataelement-52draft Number of Street draft epSOS Data Set
hl7:city
0 … 1RPatient's CityR1.5.3
 
target
epsos-dataelement-55draft City draft epSOS Data Set
hl7:postalCode
0 … 1RPatient's Postal CodeR1.5.4
 
target
epsos-dataelement-53draft Postal Code draft epSOS Data Set
hl7:state
0 … 1RPatient's State or ProvinceR1.5.5
 
target
epsos-dataelement-56draft State or Province draft epSOS Data Set
hl7:country
0 … 1RPatient's Country. When used addr.country it is always bound to the epSOSCountry value setR1.5.6
 
target
epsos-dataelement-54draft Country draft epSOS Data Set
 Constraintexperimental: add code constraint to element value.
 Schematron assertroleorange warning 
 testconcat(text(), '1.0.3166.1') = doc('include/voc-1.3.6.1.4.1.12559.11.10.1.3.1.42.4-DYNAMIC.xml')//valueSet[1]/conceptList/concept/concat(@code, @codeSystem) 
 Message the Warning Message  
hl7:telecom
TEL1 … *RPatient’s telephone number / Patient e-mail address. The patient telephone or e-mail element is required. If there is no information, the nullFlavor attribute shall have a value of 'NI' and the "value" and "use" attributes shall be omitted, otherwise the nullFlavor attribute shall not be present, and the "value" and "use" attributes shall be present Optionalities and Cardinalities of the following two items shall be interpreted according to this rule: e.g. is not expected to have two nullFlavored telecom elements.R1.6.1 / R1.6.2
 
target
epsos-dataelement-28draft Telephone No draft epSOS Data Set
epsos-dataelement-300draft Telecom draft epSOS Data Set
epsos-dataelement-29draft Email draft epSOS Data Set
@use
set_cs0 … 1 
 CONF
The value of @use shall be drawn from value set 1.3.6.1.4.1.12559.11.10.1.3.1.42.40 epSOSTelecomAddress (DYNAMIC)
@nullFlavor
cs0 … 1FNI
hl7:patient
1 … 1MepSOdotsrget
 
target
epsos-dataelement-8draft Personal Information draft epSOS Data Set
@classCode
cs0 … 1FPSN
@determinerCode
cs0 … 1FINSTANCE
hl7:name
PN1 … *RPatient NameR1.1
 
target
epsos-dataelement-9draft Full Name draft epSOS Data Set
hl7:family
1 … *MPatient's Family Name/SurnameR1.1.1
 
target
epsos-dataelement-13draft Family Name/Surname draft epSOS Data Set
hl7:prefix
0 … *RPatient's PrefixR1.1.2
 
target
epsos-dataelement-263draft Prefix draft epSOS Data Set
 ConstraintIf the attribute qualifier is used for this element it should be derived from epSOSEntityNamePartQualifier 2.16.840.1.113883.5.43
hl7:given
1 … *MPatient's Given NameR1.1.3
 
target
epsos-dataelement-12draft Given name draft epSOS Data Set
hl7:administrativeGenderCode
CE.EPSOS1 … 1RPatient's GenderR1.2
 
target
epsos-dataelement-11draft Gender draft epSOS Data Set
@nullFlavor
cs0 … 1FUNK
 CONF
The value of @code shall be drawn from value set 1.3.6.1.4.1.12559.11.10.1.3.1.42.34 epSOSAdministrativeGender (DYNAMIC)
hl7:birthTime
TS1 … 1MPatient's Date of Birth. The patient date of birth may be a partial date such as only the year.R1.3
 
target
epsos-dataelement-10draft Date of Birth draft epSOS Data Set
hl7:guardian
0 … *R

The guardians of a patient shall be recorded in the <guardian> element beneath the /ClinicalDocument/recordTarget/patientRole/patient XML - <patient> element. Other patient contacts are described using the /ClinicalDocument/participant structure. The <associatedEntity> element defines the type of contact.

The relationship between the patient and the guardian or other contact should be recorded in the <code> element. The code attribute is required and comes from the HL7 PersonalRelationshipRoleType vocabulary (epSOSPersonalRelationship value set).

The address of the guardian or other contact should be present, and shall be represented, as any other address would be in CDA.

The phone number of the guardian or other contact should be present, and shall be represented, as any other phone number would be in CDA.

The name of the guardian or other contact shall be present, and shall be represented, as any other name would be in CDA.

R1.7.A
@classCode
cs1 … 1FGUARD
@nullFlavor
cs0 … 1 Use nullFlavor if unknown or if no information is applicable
 Example<guardian classCode="GUARD">
  <templateId root="1.3.6.1.4.1.19376.1.5.3.1.2.4"/>  <addr>
    <streetAddressLine>2222 Home Street</streetAddressLine>    <city>London</city>    <state>London</state>    <postalCode>A1B 2C3</postalCode>    <country>UK</country>  </addr>
  <telecom value="tel:+452070256161"/>  <telecom value="mailto:jsmith@myprovider.co.uk"/>  <guardianPerson>
    <name>
      <given>John</given>      <family>Español Smith</family>    </name>
  </guardianPerson>
</guardian>
hl7:templateId
II.EPSOS1 … 1MTemplate id for IHE PCC Patient ContactsR1.7.A
@root
uid1 … 1F1.3.6.1.4.1.19376.1.5.3.1.2.4
hl7:addr
AD.EPSOS1 … 1RThe guardian’s address element is required. If there is no information, the nullFlavor attribute shall have a value of 'NI' and no address parts shall be present, otherwise there shall be no nullFlavor attribute, and at least one of the address parts listed below shall be presentR1.7.A
@nullFlavor
cs0 … 1FNI
hl7:streetAddressLine
0 … *RGuardian's Number of Street/Guardian's Number of StreetR1.7dots.3.2
hl7:city
0 … 1RGuardian's CityR1.7dots.3.3
hl7:postalCode
0 … 1RGuardian's Postal CodeR1.7dots.3.4
hl7:state
0 … 1RGuardian's State or ProvinceR1.7dots.3.5
hl7:country
0 … 1RGuardian's Country. When used addr.country it is always bound to the epSOSCountry value setR1.7dots.3.6
 Constraintexperimental: add code constraint to element value Guardian's Country.
 Schematron assertroleorange warning 
 testconcat(text(), '1.0.3166.1') = doc('include/voc-1.3.6.1.4.1.12559.11.10.1.3.1.42.4-DYNAMIC.xml')//valueSet[1]/conceptList/concept/concat(@code, @codeSystem) 
 Message the Warning Message for Guardian's Country  
hl7:telecom
TEL1 … *RGuardian’s telephone number / Patient e-mail address. The guardian telephone or e-mail element is required. If there is no information, the nullFlavor attribute shall have a value of 'NI' and the "value" and "use" attributes shall be omitted, otherwise the nullFlavor attribute shall not be present, and the "value" and "use" attributes shall be present Optionalities and Cardinalities of the following two items shall be interpreted according to this rule: e.g. is not expected to have two nullFlavored telecom elements.R1.7dots.4.2
 
target
epsos-dataelement-39draft Telephone No draft epSOS Data Set
@use
set_cs0 … 1 
 CONF
The value of @use shall be drawn from value set 1.3.6.1.4.1.12559.11.10.1.3.1.42.40 epSOSTelecomAddress (DYNAMIC)
@nullFlavor
cs0 … 1FNI
hl7:guardianPerson
1 … 1RR1.7.A
 
target
epsos-dataelement-34draft Contact Person/legal guardian draft epSOS Data Set
hl7:name
PN1 … *RPatient Guardian's NameIHE PCC
 
target
epsos-dataelement-36draft Full Name draft epSOS Data Set
Choice2 … *Elements to choose from:
  • hl7:family
  • hl7:given
hl7:family
1 … *RPatient Guardian's Family Name/SurnameR1.7.A.1
 
target
epsos-dataelement-38draft Family Name/Surname draft epSOS Data Set
hl7:given
1 … *RPatient Guardian's Given NameR1.7.A.2
 
target
epsos-dataelement-37draft Given Name draft epSOS Data Set
hl7:languageCommunication
0 … *RThis element is derived from the IHE template LanguageCommunication (1.3.6.1.4.1.19376.1.5.3.1.2.1), however this template does not need the element preferenceInd because the language is already said to be the "preferred language".epSOdotsrget
hl7:languageCode
CS1 … 1RPatient’s preferred language
  • The language code SHALL be in the form nn-CC.
  • The nn portion SHALL be an ISO-639-1 language code in lower case derived by the Value Set epSOSLanguage.
  • The CC portion SHALL be an ISO-3166 country code in upper case derived by the value Set epSOSCountry
R1.7
 Example<languageCode code="en-GB"/>
 Schematron assertrolered error 
 testmatches(@code,'[a-z]{2}-[A-Z]{2}') 
 MessageThe language code SHALL be in the form nn-CC where nn is ISO-639-1 epSOSLanguage and CC is ISO-3166 epSOSCountry