Back To Index  <<  Back To Templates

 Template  epSOS CDA recordTarget

Template (internal) 2.16.840.1.113883.2.4.3.11.60.22.10.12 - epSOSCDArecordTarget
Id 2.16.840.1.113883.2.4.3.11.60.22.10.12
Classification CDA header level template
Relationship Specialization: template 2.16.840.1.113883.10.12.101 (2005‑09‑07)
Version valid from 2013‑06‑04 status Under develeopment
Open/Closed Open (other than defined elements are allowed)
Used in
Used in 3 templates
Id Name as of
1.3.6.1.4.1.12559.11.10.1.3.1.1.1 epSOS-eP  epSOS-ePrescription 2012‑05‑03
1.3.6.1.4.1.12559.11.10.1.3.1.1.2 epSOS-eD  epSOS-eDispensation 2012‑05‑03
1.3.6.1.4.1.12559.11.10.1.3.1.1.3 epSOS-PS  epSOS-Patient Summary 2012‑05‑03
Item DT Card Conf Desc Label
hl7:recordTarget
1 .. * (epSOSCDArecordTarget)
treetree @typeCode
0 .. 1 F RCT
treetree @contextControlCode
0 .. 1 F OP
treetree hl7:patientRole
1 .. 1 M (epSOSCDArecordTarget)
treeblank treetree @classCode
0 .. 1 F PAT
treeblank treetree hl7:id
II 1 .. * Patient Identifiers: Primary Patient Identifier (Regional/National Health Id), Secondary Patient Identifier (Social/Insurance Number) R1.4 / R1.4.1 / R1.4.2
treeblank treeblank treetree @extension
1 .. 1  
treeblank treeblank treetree @nullFlavor
0 .. 1 F UNC
  When the @root is impossible to know, e.g. for insurance numbers, @nullFlavor SHALL be 'UNC' while @extension contains the id
Example
<id nullFlavor="UNC" extension="EHIC"/>
treeblank treetree hl7:addr
AD 1 .. 1 R The patient address <addr> 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. Optionalities and Cardinalities of the address sub-parts shall be interpreted according to this rule. R1.5
treeblank treeblank treetree @nullFlavor
0 .. 1 F NI
Choice min 0 element(s) and max * element(s). Elements to choose from:
  • hl7:streetAddressLine
  • hl7:city
  • hl7:postalCode
  • hl7:state
  • hl7:country
treeblank treeblank treeblank treetree hl7:streetAddressLine
ADXP 1 .. * Patient's Number of Street/Patient's Number of Street R1.5.1/R1.5.2
treeblank treeblank treeblank treeblank treetree @nullFlavor
0 .. 1  
  Use nullFlavor if unknown or if no information is applicable
treeblank treeblank treeblank treetree hl7:city
ADXP 1 .. * Patient's City R1.5.3
treeblank treeblank treeblank treeblank treetree @nullFlavor
0 .. 1  
  Use nullFlavor if unknown or if no information is applicable
treeblank treeblank treeblank treetree hl7:postalCode
ADXP 1 .. * Patient's Postal Code R1.5.4
treeblank treeblank treeblank treeblank treetree @nullFlavor
0 .. 1  
  Use nullFlavor if unknown or if no information is applicable
treeblank treeblank treeblank treetree hl7:state
ADXP 1 .. * Patient's State or Province R1.5.5
treeblank treeblank treeblank treeblank treetree @nullFlavor
0 .. 1  
  Use nullFlavor if unknown or if no information is applicable
treeblank treeblank treeblank treetree hl7:country
ADXP 1 .. * Patient's Country R1.5.6
treeblank treeblank treeblank treeblank treetree @nullFlavor
0 .. 1  
  Use nullFlavor if unknown or if no information is applicable
treeblank treetree hl7:telecom
TEL 1 .. * R Patient’s telephone number / Patient e-mail address. The patient telephone or e-mail <telecom> 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
treeblank treeblank treetree @use
0 .. 1  
  CONF
The value of @use shall be drawn from value set epSOSTelecomAddress (DYNAMIC)
treeblank treeblank treetree @nullFlavor
0 .. 1 F NI
treeblank treetree hl7:patient
1 .. 1 M (epSOSCDArecordTarget)
treeblank treeblank treetree @classCode
0 .. 1 F PSN
treeblank treeblank treetree @determinerCode
0 .. 1 F INSTANCE
treeblank treeblank treetree hl7:name
PN 1 .. * Patient Name R1.1
Choice min 1 element(s) and max * element(s). Elements to choose from:
  • hl7:family
  • hl7:prefix
  • hl7:given
treeblank treeblank treeblank treeblank treetree hl7:family
ENXP 1 .. * Patient's Family Name/Surname R1.1.1
treeblank treeblank treeblank treeblank treetree hl7:prefix
ENXP 0 .. * 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
treeblank treeblank treeblank treeblank treetree hl7:given
ENXP 1 .. * Patient's Given Name R1.1.3
treeblank treeblank treetree hl7:administrativeGenderCode
CE 1 .. 1 Patient's Gender R1.2
CONF
The value of @code shall be drawn from value set epSOSAdministrativeGender (DYNAMIC)
treeblank treeblank treetree hl7:birthTime
TS 1 .. 1 M Patient's Date of Birth R1.3
treeblank treeblank treetree hl7:guardian
1 .. * 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 classCode attribute shall be present, and contains a value from the set AGNT, CAREGIVER, ECON, NOK, or PRS to identify contacts that are agents of the patient, care givers, emergency contacts, next of kin, or other relations respectively.

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 480 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.

Healthcare Service Identification

The Healthcare Service Identification information is represented in structures under the /ClinicalDocument/author XML element

R1.7.A
treeblank treeblank treeblank treetree @classCode
1 .. 1 F GUARD
treeblank treeblank treeblank treetree @nullFlavor
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>
treeblank treeblank treeblank treetree hl7:templateId
II 1 .. 1 M Template id for Patient's Guardian R1.7.A
treeblank treeblank treeblank treeblank treetree @root
1 .. 1 F 1.3.6.1.4.1.19376.1.5.3.1.2.4
treeblank treeblank treeblank treetree hl7:addr
AD 1 .. 1 The guardian’s address <addr> element is required. If there is no information, the nullFlavor attribute shall have a value of 'UNK' 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
treeblank treeblank treeblank treeblank treetree @nullFlavor
0 .. 1 F UNK
treeblank treeblank treeblank treeblank treetree hl7:streetAddressLine
ADXP 1 .. * Guardian's Number of Street/Guardian's Number of Street R1.7.A.3.1/R1.7.A.3.2
treeblank treeblank treeblank treeblank treeblank treetree @nullFlavor
0 .. 1  
  Use nullFlavor if unknown or if no information is applicable
treeblank treeblank treeblank treeblank treetree hl7:city
ADXP 1 .. * Guardian's City R1.7.A.3.3
treeblank treeblank treeblank treeblank treeblank treetree @nullFlavor
0 .. 1  
  Use nullFlavor if unknown or if no information is applicable
treeblank treeblank treeblank treeblank treetree hl7:postalCode
ADXP 1 .. * Guardian's Postal Code R1.7.A.3.4
treeblank treeblank treeblank treeblank treeblank treetree @nullFlavor
0 .. 1  
  Use nullFlavor if unknown or if no information is applicable
treeblank treeblank treeblank treeblank treetree hl7:state
ADXP 1 .. * Guardian's State or Province R1.7.A.3.5
treeblank treeblank treeblank treeblank treeblank treetree @nullFlavor
0 .. 1  
  Use nullFlavor if unknown or if no information is applicable
treeblank treeblank treeblank treeblank treetree hl7:country
ADXP 1 .. * Guardian's Country R1.7.A.3.6
treeblank treeblank treeblank treeblank treeblank treetree @nullFlavor
0 .. 1  
  Use nullFlavor if unknown or if no information is applicable
treeblank treeblank treeblank treetree hl7:telecom
TEL 1 .. * R Guardian’s telephone number / Patient e-mail address. The guardian telephone or e-mail <telecom> 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.A.4.1/R1.7.A.4.2
treeblank treeblank treeblank treeblank treetree @use
0 .. 1  
  CONF
The value of @use shall be drawn from value set epSOSTelecomAddress (DYNAMIC)
treeblank treeblank treeblank treeblank treetree @nullFlavor
0 .. 1 F NI
treeblank treeblank treeblank treetree hl7:guardianPerson
1 .. 1 R R1.7.A
treeblank treeblank treeblank treeblank treetree hl7:name
PN 1 .. * Patient Guardian's Name R1.7.A
Choice min 1 element(s) and max * element(s). Elements to choose from:
  • hl7:family
  • hl7:given
treeblank treeblank treeblank treeblank treeblank treeblank treetree hl7:family
ENXP 1 .. * Patient Guardian's Family Name/Surname R1.7.A.1
treeblank treeblank treeblank treeblank treeblank treeblank treetree hl7:given
ENXP 1 .. * Patient Guardian's Given Name R1.7.A.2
treeblank treeblank treetree hl7:languageCommunication
0 .. * R (epSOSCDArecordTarget)
treeblank treeblank treeblank treetree hl7:templateId
II 1 .. 1 M Template id for LanguageCommunication (epSOSCDArecordTarget)
treeblank treeblank treeblank treeblank treetree @root
1 .. 1 F 1.3.6.1.4.1.19376.1.5.3.1.2.1
treeblank treeblank treeblank treetree hl7:languageCode
CS 0 .. 1 R Patient’s preferred language R1.7
CONF
The value of @code shall be drawn from value set epSOSLanguage (DYNAMIC)