Back To Index << Back To Templates

# 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: eHDSIRecordTarget as of 2025‑01‑23 14:44:23 eHDSIRecordTarget as of 2024‑04‑10 12:26:40 eHDSIRecordTarget as of 2020‑04‑16 10:58:00 epSOSCDArecordTarget as of 2020‑04‑03 16:17:28 epSOSCDArecordTarget as of 2018‑11‑14 10:54:53 epSOSCDArecordTarget as of 2013‑12‑20
Status | Retired | 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 | Dataset
--- | --- | ---
ehdsi-dataelement-148 | E-mail | eHDSI Data Set
ehdsi-dataelement-150 | Telephone No | eHDSI Data Set
ehdsi-dataelement-152 | Country | eHDSI Data Set
ehdsi-dataelement-153 | State or Province | eHDSI Data Set
ehdsi-dataelement-154 | Postal Code | eHDSI Data Set
ehdsi-dataelement-155 | City | eHDSI Data Set
ehdsi-dataelement-156 | Number of Street | eHDSI Data Set
ehdsi-dataelement-157 | Street | eHDSI Data Set
ehdsi-dataelement-159 | Gender Code | eHDSI Data Set
ehdsi-dataelement-161 | Date of Birth | eHDSI Data Set
ehdsi-dataelement-163 | Family Name/Surname | eHDSI Data Set
ehdsi-dataelement-164 | Given Name | eHDSI Data Set
ehdsi-dataelement-167 | Insurance Number | eHDSI Data Set
ehdsi-dataelement-170 | National Healthcare Patient identifier (Country of Affiliation) | eHDSI Data Set
ehdsi-dataelement-239 | Social/Insurance Number | eHDSI Data Set
ehdsi-dataelement-242 | Date of Birth | eHDSI Data Set
ehdsi-dataelement-244 | Gender | eHDSI Data Set
ehdsi-dataelement-246 | Family Name/Surname | eHDSI Data Set
ehdsi-dataelement-247 | Given Name | eHDSI Data Set
ehdsi-dataelement-250 | Regional/National Health Identifier | eHDSI Data Set
ehdsi-dataelement-307 | Gender | eHDSI Data Set
ehdsi-dataelement-309 | Family Name/Surname | eHDSI Data Set
ehdsi-dataelement-310 | Given Name | eHDSI Data Set
ehdsi-dataelement-313 | Social/Insurance Number | eHDSI Data Set
ehdsi-dataelement-316 | Regional/National Health Identifier | eHDSI Data Set
ehdsi-dataelement-337 | Country | eHDSI Data Set
ehdsi-dataelement-338 | State or Province | eHDSI Data Set
ehdsi-dataelement-339 | Postal Code | eHDSI Data Set
ehdsi-dataelement-340 | City | eHDSI Data Set
ehdsi-dataelement-341 | Number of Street | eHDSI Data Set
ehdsi-dataelement-342 | Street | eHDSI Data Set
ehdsi-dataelement-344 | Gender Code | eHDSI Data Set
ehdsi-dataelement-346 | Date of Birth | eHDSI Data Set
ehdsi-dataelement-349 | Family Name/Surname | eHDSI Data Set
ehdsi-dataelement-350 | Given Name | eHDSI Data Set
ehdsi-dataelement-353 | Insurance Number | eHDSI Data Set
ehdsi-dataelement-356 | Regional/National Health ID (Country of Affiliation) | eHDSI Data Set
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 |  |
@typeCode | cs | 0 … 1 | F | RCT
@contextControlCode | cs | 0 … 1 | F | OP
hl7:patientRole |  | 1 … 1 | M |  |
@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
ehdsi-dataelement-167 | Insurance Number | eHDSI Data Set
ehdsi-dataelement-170 | National Healthcare Patient identifier (Country of Affiliation) | eHDSI Data Set
ehdsi-dataelement-239 | Social/Insurance Number | eHDSI Data Set
ehdsi-dataelement-250 | Regional/National Health Identifier | eHDSI Data Set
ehdsi-dataelement-313 | Social/Insurance Number | eHDSI Data Set
ehdsi-dataelement-316 | Regional/National Health Identifier | eHDSI Data Set
ehdsi-dataelement-353 | Insurance Number | eHDSI Data Set
ehdsi-dataelement-356 | Regional/National Health ID (Country of Affiliation) | 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
ehdsi-dataelement-156 | Number of Street | eHDSI Data Set
ehdsi-dataelement-157 | Street | eHDSI Data Set
ehdsi-dataelement-341 | Number of Street | eHDSI Data Set
ehdsi-dataelement-342 | Street | eHDSI Data Set
hl7:city |  | 0 … 1 | R | Patient's City | R1.5.3
ehdsi-dataelement-155 | City | eHDSI Data Set
ehdsi-dataelement-340 | City | eHDSI Data Set
hl7:postalCode |  | 0 … 1 | R | Patient's Postal Code | R1.5.4
ehdsi-dataelement-154 | Postal Code | eHDSI Data Set
ehdsi-dataelement-339 | Postal Code | eHDSI Data Set
hl7:state |  | 0 … 1 | R | Patient's State or Province | R1.5.5
ehdsi-dataelement-153 | State or Province | eHDSI Data Set
ehdsi-dataelement-338 | State or Province | 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
ehdsi-dataelement-152 | Country | eHDSI Data Set
ehdsi-dataelement-337 | Country | 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
ehdsi-dataelement-148 | E-mail | eHDSI Data Set
ehdsi-dataelement-150 | Telephone No | 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 |  |
@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
ehdsi-dataelement-163 | Family Name/Surname | eHDSI Data Set
ehdsi-dataelement-246 | Family Name/Surname | eHDSI Data Set
ehdsi-dataelement-309 | Family Name/Surname | eHDSI Data Set
ehdsi-dataelement-349 | Family Name/Surname | 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
ehdsi-dataelement-164 | Given Name | eHDSI Data Set
ehdsi-dataelement-247 | Given Name | eHDSI Data Set
ehdsi-dataelement-310 | Given Name | eHDSI Data Set
ehdsi-dataelement-350 | Given Name | eHDSI Data Set
hl7:administrativeGenderCode | CE.EPSOS | 1 … 1 | R | Patient's Gender | R1.2
ehdsi-dataelement-159 | Gender Code | eHDSI Data Set
ehdsi-dataelement-244 | Gender | eHDSI Data Set
ehdsi-dataelement-307 | Gender | eHDSI Data Set
ehdsi-dataelement-344 | Gender Code | 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
ehdsi-dataelement-161 | Date of Birth | eHDSI Data Set
ehdsi-dataelement-242 | Date of Birth | eHDSI Data Set
ehdsi-dataelement-346 | Date of Birth | 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.7.3.2
hl7:city |  | 0 … 1 | R | Guardian's City | R1.7.3.3
hl7:postalCode |  | 0 … 1 | R | Guardian's Postal Code | R1.7.3.4
hl7:state |  | 0 … 1 | R | Guardian's State or Province | R1.7.3.5
hl7:country |  | 0 … 1 | R | Guardian's Country. When used addr.country it is always bound to the eHDSICountry value set | R1.7.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.7.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". |
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 | 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 |