Back To Index  <<  Back To Templates

active Template  eHDSI RecordTarget

Id 2.16.840.1.113883.3.1937.777.11.10.100 Effective Date 2020‑10‑02 14:05:45
Other versions this id:
Status active Active Version Label
Name eHDSIRecordTarget Display Name eHDSI RecordTarget
Classification CDA Header Level Template
Open/Closed Open (other than defined elements are allowed)
Associated with
Associated with 37 concepts
Id Name Data Set
ehdsi-dataelement-342 draft Street draft eHDSI Data Set
ehdsi-dataelement-250 draft Regional/National Health Identifier draft eHDSI Data Set
ehdsi-dataelement-155 draft City draft eHDSI Data Set
ehdsi-dataelement-157 draft Street draft eHDSI Data Set
ehdsi-dataelement-153 draft State or Province draft eHDSI Data Set
ehdsi-dataelement-156 draft Number of Street draft eHDSI Data Set
ehdsi-dataelement-154 draft Postal Code draft eHDSI Data Set
ehdsi-dataelement-161 draft Date of Birth draft eHDSI Data Set
ehdsi-dataelement-356 draft Regional/National Health ID (Country of Affiliation) draft eHDSI Data Set
ehdsi-dataelement-170 draft National Healthcare Patient identifier (Country of Affiliation) draft eHDSI Data Set
ehdsi-dataelement-164 draft Given Name draft eHDSI Data Set
ehdsi-dataelement-313 draft Social/Insurance Number draft eHDSI Data Set
ehdsi-dataelement-244 draft Gender draft eHDSI Data Set
ehdsi-dataelement-159 draft Gender Code draft eHDSI Data Set
ehdsi-dataelement-246 draft Family Name/Surname draft eHDSI Data Set
ehdsi-dataelement-338 draft State or Province draft eHDSI Data Set
ehdsi-dataelement-309 draft Family Name/Surname draft eHDSI Data Set
ehdsi-dataelement-150 draft Telephone No draft eHDSI Data Set
ehdsi-dataelement-340 draft City draft eHDSI Data Set
ehdsi-dataelement-152 draft Country draft eHDSI Data Set
ehdsi-dataelement-239 draft Social/Insurance Number draft eHDSI Data Set
ehdsi-dataelement-307 draft Gender draft eHDSI Data Set
ehdsi-dataelement-353 draft Insurance Number draft eHDSI Data Set
ehdsi-dataelement-148 draft E-mail draft eHDSI Data Set
ehdsi-dataelement-163 draft Family Name/Surname draft eHDSI Data Set
ehdsi-dataelement-346 draft Date of Birth draft eHDSI Data Set
ehdsi-dataelement-247 draft Given Name draft eHDSI Data Set
ehdsi-dataelement-310 draft Given Name draft eHDSI Data Set
ehdsi-dataelement-344 draft Gender Code draft eHDSI Data Set
ehdsi-dataelement-242 draft Date of Birth draft eHDSI Data Set
ehdsi-dataelement-341 draft Number of Street draft eHDSI Data Set
ehdsi-dataelement-350 draft Given Name draft eHDSI Data Set
ehdsi-dataelement-337 draft Country draft eHDSI Data Set
ehdsi-dataelement-339 draft Postal Code draft eHDSI Data Set
ehdsi-dataelement-316 draft Regional/National Health Identifier draft eHDSI Data Set
ehdsi-dataelement-167 draft Insurance Number draft eHDSI Data Set
ehdsi-dataelement-349 draft Family Name/Surname draft eHDSI Data Set
Used by / Uses
Used by 11 transactions and 43 templates, Uses 0 templates
Used by as Name Version
epsos-transactions-44 Transaction draft Return OrCD Medical Imaging Report of country A 2021‑04‑30 11:27:45
epsos-transactions-41 Transaction draft Return OrCD Medical Images of country A 2021‑04‑30 11:16:15
epsos-transactions-38 Transaction draft Return OrCD Laboratory Result of country A 2021‑04‑30 11:00:04
epsos-transactions-35 Transaction draft Return OrCD Hospital Discharge Report of country A 2021‑04‑30 09:22:38
epsos-transactions-32 Transaction draft Return eP (PDF embedded) from country A 2017‑11‑21 10:26:49
epsos-transactions-29 Transaction draft Return PS (PDF embedded) of country A 2017‑11‑20 18:28:16
epsos-transactions-19 Transaction draft Return eP from country A 2013‑11‑02
epsos-transactions-25 Transaction draft Send eD to country A 2013‑11‑02
epsos-transactions-23 Transaction draft Return MRO 2013‑11‑02
epsos-transactions-21 Transaction draft Send HCER to country A 2013‑11‑02
epsos-transactions-12 Transaction draft Return PS of country A 2012‑05‑02
1.3.6.1.4.1.12559.11.10.1.3.1.1.1 Include active eHDSI ePrescription 2022‑09‑12 13:39:27
1.3.6.1.4.1.12559.11.10.1.3.1.1.1 Include retired eHDSI ePrescription 2020‑09‑09 12:22:47
1.3.6.1.4.1.12559.11.10.1.3.1.1.1 Include retired eHDSI ePrescription 2020‑09‑09 12:19:36
1.3.6.1.4.1.12559.11.10.1.3.1.1.1 Include retired eHDSI ePrescription 2020‑06‑17 09:25:30
1.3.6.1.4.1.12559.11.10.1.3.1.1.1 Include retired eHDSI ePrescription 2020‑04‑16 10:42:14
1.3.6.1.4.1.12559.11.10.1.3.1.1.1 Include retired epSOS-ePrescription 2018‑11‑14 10:49:44
1.3.6.1.4.1.12559.11.10.1.3.1.1.1 Include retired epSOS-ePrescription 2013‑12‑20
1.3.6.1.4.1.12559.11.10.1.3.1.1.10 Include active eHDSI OrCD Medical Imaging Report 2022‑09‑12 13:42:07
1.3.6.1.4.1.12559.11.10.1.3.1.1.10 Include retired eHDSI OrCD Medical Imaging Report 2020‑11‑30 16:12:00
1.3.6.1.4.1.12559.11.10.1.3.1.1.11 Include active eHDSI OrCD Medical Images 2022‑09‑12 13:41:33
1.3.6.1.4.1.12559.11.10.1.3.1.1.11 Include retired eHDSI OrCD Medical Images 2021‑01‑18 16:22:00
1.3.6.1.4.1.12559.11.10.1.3.1.1.2 Include active eHDSI eDispensation 2022‑09‑12 13:38:46
1.3.6.1.4.1.12559.11.10.1.3.1.1.2 Include retired eHDSI eDispensation 2020‑09‑09 12:09:23
1.3.6.1.4.1.12559.11.10.1.3.1.1.2 Include retired eHDSI eDispensation 2020‑08‑31 08:12:35
1.3.6.1.4.1.12559.11.10.1.3.1.1.2 Include retired eHDSI eDispensation 2020‑04‑16 10:41:22
1.3.6.1.4.1.12559.11.10.1.3.1.1.2 Include retired epSOS-eDispensation 2020‑04‑06 19:20:14
1.3.6.1.4.1.12559.11.10.1.3.1.1.2 Include retired epSOS-eDispensation 2019‑11‑11 14:43:22
1.3.6.1.4.1.12559.11.10.1.3.1.1.2 Include retired epSOS-eDispensation 2018‑11‑14 10:49:04
1.3.6.1.4.1.12559.11.10.1.3.1.1.2 Include retired epSOS-eDispensation 2013‑12‑20
1.3.6.1.4.1.12559.11.10.1.3.1.1.3 Include active eHDSI Patient Summary 2022‑09‑12 13:44:19
1.3.6.1.4.1.12559.11.10.1.3.1.1.3 Include retired eHDSI Patient Summary 2020‑09‑02 10:19:44
1.3.6.1.4.1.12559.11.10.1.3.1.1.3 Include retired eHDSI Patient Summary 2020‑04‑14 13:03:47
1.3.6.1.4.1.12559.11.10.1.3.1.1.3 Include retired epSOS-Patient Summary 2018‑11‑14 10:53:50
1.3.6.1.4.1.12559.11.10.1.3.1.1.3 Include retired epSOS-Patient Summary 2013‑12‑20
1.3.6.1.4.1.12559.11.10.1.3.1.1.4 Include retired epSOS-Health Care Encounter Report 2018‑11‑14 09:02:41
1.3.6.1.4.1.12559.11.10.1.3.1.1.4 Include retired epSOS-Health Care Encounter Report 2013‑12‑20
1.3.6.1.4.1.12559.11.10.1.3.1.1.5 Include retired epSOS-Medication Related Overview 2018‑11‑14 09:03:13
1.3.6.1.4.1.12559.11.10.1.3.1.1.5 Include retired epSOS-Medication Related Overview 2013‑12‑20
1.3.6.1.4.1.12559.11.10.1.3.1.1.6 Include active eHDSI ePrescription PDF embedded 2022‑09‑12 13:39:56
1.3.6.1.4.1.12559.11.10.1.3.1.1.6 Include retired eHDSI ePrescription PDF embedded 2020‑09‑09 12:25:17
1.3.6.1.4.1.12559.11.10.1.3.1.1.6 Include retired eHDSI ePrescription PDF embedded 2020‑06‑17 09:27:29
1.3.6.1.4.1.12559.11.10.1.3.1.1.6 Include retired eHDSI ePrescription PDF embedded 2020‑04‑16 10:39:54
1.3.6.1.4.1.12559.11.10.1.3.1.1.6 Include retired eHDSI-ePrescription PDF embedded 2018‑11‑14 09:01:05
1.3.6.1.4.1.12559.11.10.1.3.1.1.6 Include retired eHDSI-ePrescription PDF embedded 2017‑03‑11 22:32:59
1.3.6.1.4.1.12559.11.10.1.3.1.1.7 Include active eHDSI Patient Summary PDF embedded 2022‑09‑12 13:45:01
1.3.6.1.4.1.12559.11.10.1.3.1.1.7 Include retired eHDSI Patient Summary PDF embedded 2020‑09‑09 12:49:26
1.3.6.1.4.1.12559.11.10.1.3.1.1.7 Include retired eHDSI Patient Summary PDF embedded 2020‑04‑14 13:05:42
1.3.6.1.4.1.12559.11.10.1.3.1.1.7 Include retired eHDSI-Patient Summary PDF embedded 2018‑11‑14 09:01:49
1.3.6.1.4.1.12559.11.10.1.3.1.1.7 Include retired eHDSI-Patient Summary PDF embedded 2017‑03‑11 18:41:31
1.3.6.1.4.1.12559.11.10.1.3.1.1.8 Include active eHDSI OrCD Laboratory Result 2022‑09‑12 13:40:54
1.3.6.1.4.1.12559.11.10.1.3.1.1.8 Include retired eHDSI OrCD Laboratory Result 2020‑11‑27 14:52:00
1.3.6.1.4.1.12559.11.10.1.3.1.1.9 Include active eHDSI OrCD Hospital Discharge Report 2022‑09‑12 13:40:30
1.3.6.1.4.1.12559.11.10.1.3.1.1.9 Include retired eHDSI OrCD Hospital Discharge Report 2020‑11‑30 15:46:00
Relationship Version: template 2.16.840.1.113883.3.1937.777.11.10.100 eHDSI RecordTarget (2020‑04‑16 10:58:00)
Version: template 2.16.840.1.113883.3.1937.777.11.10.100 epSOS CDA recordTarget (2018‑11‑14 10:54:53)
Specialization: template 2.16.840.1.113883.10.12.101 CDA recordTarget (2005‑09‑07)
ref
ad1bbr-
Item DT Card Conf Description Label
hl7:recordTarget
1 … * R (eHDdotsget)
@typeCode
cs 0 … 1 F RCT
@contextControlCode
cs 0 … 1 F OP
hl7:patientRole
1 … 1 M (eHDdotsget)
@classCode
cs 0 … 1 F PAT
hl7:id
II.EPSOS 1 … * R Patient Identifiers: Primary Patient Identifier (Regional/National Health Id), Secondary Patient Identifier (Social/Insurance Number) R1.4 / R1.4.1 / R1.4.2
 
target
ehdsi-dataelement-250 draft Regional/National Health Identifier draft eHDSI Data Set
ehdsi-dataelement-356 draft Regional/National Health ID (Country of Affiliation) draft eHDSI Data Set
ehdsi-dataelement-170 draft National Healthcare Patient identifier (Country of Affiliation) draft eHDSI Data Set
ehdsi-dataelement-313 draft Social/Insurance Number draft eHDSI Data Set
ehdsi-dataelement-239 draft Social/Insurance Number draft eHDSI Data Set
ehdsi-dataelement-353 draft Insurance Number draft eHDSI Data Set
ehdsi-dataelement-316 draft Regional/National Health Identifier draft eHDSI Data Set
ehdsi-dataelement-167 draft Insurance Number draft eHDSI Data Set
hl7:addr
AD.EPSOS 1 … 1 R The 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
@nullFlavor
cs 0 … 1 F NI
hl7:streetAddressLine
0 … * R Patient's Number of Street/Patient's Number of Street R1.5.1 / R1.5.2
 
target
ehdsi-dataelement-342 draft Street draft eHDSI Data Set
ehdsi-dataelement-157 draft Street draft eHDSI Data Set
ehdsi-dataelement-156 draft Number of Street draft eHDSI Data Set
ehdsi-dataelement-341 draft Number of Street draft eHDSI Data Set
hl7:city
0 … 1 R Patient's City R1.5.3
 
target
ehdsi-dataelement-155 draft City draft eHDSI Data Set
ehdsi-dataelement-340 draft City draft eHDSI Data Set
hl7:postalCode
0 … 1 R Patient's Postal Code R1.5.4
 
target
ehdsi-dataelement-154 draft Postal Code draft eHDSI Data Set
ehdsi-dataelement-339 draft Postal Code draft eHDSI Data Set
hl7:state
0 … 1 R Patient's State or Province R1.5.5
 
target
ehdsi-dataelement-153 draft State or Province draft eHDSI Data Set
ehdsi-dataelement-338 draft State or Province draft eHDSI Data Set
hl7:country
0 … 1 R Patient's Country. When used addr.country it is always bound to the eHDSICountry value set R1.5.6
 
target
ehdsi-dataelement-152 draft Country draft eHDSI Data Set
ehdsi-dataelement-337 draft Country draft eHDSI Data Set
  Constraint The content of this element SHALL be selected from ValueSet eHDSICountry urn:oid:1.3.6.1.4.1.12559.11.10.1.3.1.42.4
hl7:telecom
TEL 1 … * R Patient’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
ehdsi-dataelement-150 draft Telephone No draft eHDSI Data Set
ehdsi-dataelement-148 draft E-mail draft eHDSI Data Set
@use
set_cs 0 … 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 eHDSITelecomAddress (DYNAMIC)
@nullFlavor
cs 0 … 1 F NI
hl7:patient
1 … 1 M (eHDdotsget)
@classCode
cs 0 … 1 F PSN
@determinerCode
cs 0 … 1 F INSTANCE
hl7:name
PN 1 … * M Patient Name R1.1
hl7:family
1 … * M Patient's Family Name/Surname R1.1.1
 
target
ehdsi-dataelement-246 draft Family Name/Surname draft eHDSI Data Set
ehdsi-dataelement-309 draft Family Name/Surname draft eHDSI Data Set
ehdsi-dataelement-163 draft Family Name/Surname draft eHDSI Data Set
ehdsi-dataelement-349 draft Family Name/Surname draft eHDSI Data Set
hl7:prefix
0 … * R Patient's Prefix R1.1.2
  Constraint If the attribute qualifier is used for this element it should be derived from epSOSEntityNamePartQualifier 2.16.840.1.113883.5.43
hl7:given
1 … * M Patient's Given Name R1.1.3
 
target
ehdsi-dataelement-164 draft Given Name draft eHDSI Data Set
ehdsi-dataelement-247 draft Given Name draft eHDSI Data Set
ehdsi-dataelement-310 draft Given Name draft eHDSI Data Set
ehdsi-dataelement-350 draft Given Name draft eHDSI Data Set
hl7:administrativeGenderCode
CE.EPSOS 1 … 1 R Patient's Gender R1.2
 
target
ehdsi-dataelement-244 draft Gender draft eHDSI Data Set
ehdsi-dataelement-159 draft Gender Code draft eHDSI Data Set
ehdsi-dataelement-307 draft Gender draft eHDSI Data Set
ehdsi-dataelement-344 draft Gender Code draft eHDSI Data Set
@nullFlavor
cs 0 … 1 F UNK
  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 eHDSIAdministrativeGender (DYNAMIC)
hl7:birthTime
TS 1 … 1 M Patient's Date of Birth. The patient date of birth may be a partial date such as only the year. R1.3
 
target
ehdsi-dataelement-161 draft Date of Birth draft eHDSI Data Set
ehdsi-dataelement-346 draft Date of Birth draft eHDSI Data Set
ehdsi-dataelement-242 draft Date of Birth draft eHDSI 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 (eHDSIPersonalRelationship 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
cs 1 … 1 F GUARD
@nullFlavor
cs 0 … 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.EPSOS 1 … 1 M Template id for IHE PCC Patient Contacts R1.7.A
@root
uid 1 … 1 F 1.3.6.1.4.1.19376.1.5.3.1.2.4
hl7:addr
AD.EPSOS 1 … 1 R The 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 present R1.7.A
@nullFlavor
cs 0 … 1 F NI
hl7:streetAddressLine
0 … * R Guardian's Number of Street/Guardian's Number of Street R1.7dots.3.2
hl7:city
0 … 1 R Guardian's City R1.7dots.3.3
hl7:postalCode
0 … 1 R Guardian's Postal Code R1.7dots.3.4
hl7:state
0 … 1 R Guardian's State or Province R1.7dots.3.5
hl7:country
0 … 1 R Guardian's Country. When used addr.country it is always bound to the eHDSICountry value set R1.7dots.3.6
  Constraint The content of this element SHALL be selected from ValueSet eHDSICountry urn:oid:1.3.6.1.4.1.12559.11.10.1.3.1.42.4
hl7:telecom
TEL 1 … * R Guardian’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
@use
set_cs 0 … 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 eHDSITelecomAddress (DYNAMIC)
@nullFlavor
cs 0 … 1 F NI
hl7:guardianPerson
1 … 1 R R1.7.A
hl7:name
PN 1 … * R Patient Guardian's Name IHE PCC
Choice 2 … * Elements to choose from:
  • hl7:family
  • hl7:given
hl7:family
1 … * R Patient Guardian's Family Name/Surname R1.7.A.1
hl7:given
1 … * R Patient Guardian's Given Name R1.7.A.2
hl7:languageCommunication
0 … * R This 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". (eHDdotsget)
hl7:languageCode
CS 1 … 1 R Patient’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 eHDSILanguage.
  • The CC portion SHALL be an ISO-3166 country code in upper case derived by the value Set eHDSICountry.
R1.7
  CONF
The value of @code shall be drawn from value set 1.3.6.1.4.1.12559.11.10.1.3.1.42.6 eHDSILanguage (DYNAMIC)
  Example <languageCode code="en-GB"/>
  Schematron assert role red error  
  test matches(@code,'[a-z]{2}-[A-Z]{2}')  
  Message The language code SHALL be in the form nn-CC where nn is ISO-639-1 eHDSILanguage and CC is ISO-3166 eHDSICountry