Back To Index  <<  Back To Templates

draft Template  epSOS CDA Contact/Preferred HP/Legal Organization

Template (internal) 2.16.840.1.113883.3.1937.777.10.10.101 - epSOSCDAContactOrPreferredHP
Id 2.16.840.1.113883.3.1937.777.10.10.101
Version valid from 2013‑12‑20 status draft Under develeopment
Classification CDA Header Level Template
Open/Closed Open (other than defined elements are allowed)
Description

The guardians of a patient shall be recorded in the <guardian> element beneath the /ClinicalDocument/recordTarget/patientRole/patient XML - <patient> element. Other patient contacts such as the preferred health provider 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

Used by / Uses
Used by / Uses 3 templates
Used by Template id as Name Version
1.3.6.1.4.1.12559.11.10.1.3.1.1.3 epSOS-PS epSOS-Patient Summary 2013‑12‑20
1.3.6.1.4.1.12559.11.10.1.3.1.1.4 epSOS-HCER epSOS-Health Care Encounter Report 2013‑12‑20
1.3.6.1.4.1.12559.11.10.1.3.1.1.5 epSOS-MRO epSOS-Medication Related Overview 2013‑12‑20
Relationship Specialization: template 2.16.840.1.113883.10.12.108 (DYNAMIC)
Adaptation: template 1.3.6.1.4.1.19376.1.5.3.1.2.4 (DYNAMIC)
Item DT Card Conf Description Label
hl7:participant
where
[hl7:templateId/@root='1.3.6.1.4.1.19376.1.5.3.1.2.4']
R Contact person / Preferred Health Professional to contact about patient. (epSOSCDAContactOrPreferredHP)
treetree @typeCode
1 .. 1 F IND
  Participant typeCode
  Example
Contact person
<participant typeCode="IND">
  <templateId root="1.3.6.1.4.1.19376.1.5.3.1.2.4"/>
  <time value="20070213"/>
  <associatedEntity classCode="NOK">
    <addr>
      <streetAddressLine>Promenade des Anglais 111</streetAddressLine>      <city>Lyon</city>      <postalCode>69001</postalCode>      <country>FR</country>    </addr>
    <telecom value="tel:(+33)555-20036" use="WP"/>
    <associatedPerson>
      <name>
        <given>Martha</given>        <family>Mum</family>      </name>
    </associatedPerson>
  </associatedEntity>
</participant>
  Example
Preferred HP
<participant typeCode="IND">
  <templateId root="1.3.6.1.4.1.19376.1.5.3.1.2.4"/>
  <functionCode code="PCP" codeSystem="2.16.840.1.113883.5.88"/>
  <associatedEntity classCode="PRS">
    <addr>
      <streetAddressLine>Karl Strasse</streetAddressLine>      <city>Freiberg</city>      <postalCode>09599</postalCode>      <country>DE</country>    </addr>
    <telecom value="tel:(+49)761-11110000" use="WP"/>
    <associatedPerson>
      <name>
        <given>Arzt</given>        <family>Guter</family>      </name>
    </associatedPerson>
  </associatedEntity>
</participant>
treetree hl7:templateId
1 .. 1 M (epSOSCDAContactOrPreferredHP)
treeblank treetree @root
1 .. 1 F 1.3.6.1.4.1.19376.1.5.3.1.2.4
treetree hl7:functionCode
0 .. 1 C (epSOSCDAContactOrPreferredHP)
  Constraint The <functionCode> element is mandatory when this participant is the preferred HP
treeblank treetree @code
1 .. 1 F PCP
treeblank treetree @codeSystem
1 .. 1 F 2.16.840.1.113883.5.88 (HL7 ParticipationFunction)
treetree hl7:time
IVL_TS.EPSOS.TZ.OPT 0 .. 1 R The <time> element may be present and indicates the time of the participation. (epSOSCDAContactOrPreferredHP)
treetree hl7:associatedEntity
R The <associatedEntity> element identifies the type of contact. The classCode attribute shall be present, and contains a value from the epSOSRoleClass value set when used for the patient contacts; ‘PRS’ when used for “Preferred HP / Legal Organization”. (epSOSCDAContactOrPreferredHP)
treeblank treetree @classCode
1 .. 1 R
  CONF
The value of @classCode shall be drawn from value set 1.3.6.1.4.1.12559.11.10.1.3.1.42.39 epSOSRoleClass (DYNAMIC)
or
@classCode shall be "PRS"
treeblank treetree hl7:code
CV.EPSOS 0 .. 1 R 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 with codeSystem (2.16.840.1.113883.5.111). The codeSystem attribute is required. The relationship between the patient and his preferred HP comes from the the full RoleCode (2.16.840.1.113883.5.111) codeSystem R1.8.6
treeblank treeblank treetree @codeSystem
1 .. 1 F 2.16.840.1.113883.5.111 (RoleCode)
treeblank treetree hl7:addr
AD.EPSOS 1 .. 1 R Patient Contact's / Preferred HP's Address R1.8.3 / R1.9.2
treeblank treeblank treetree @nullFlavor
0 .. 1 F NI
  Schematron assert role red error
  test @nullFlavor or hl7:*
  Message If addr is not nullflavored at least one sub element has to be provided
treeblank treeblank treetree hl7:streetAddressLine
0 .. * R Patient Contact's Street/Number of Street / Preferred HP's Street/Number of Street R1.8.3.1 / R1.8.3.2 / R1.9.2.1 / R1.9.2.2
treeblank treeblank treetree hl7:city
0 .. 1 R Patient Contact's City / Preferred HP's City R1.8.2.3 / R1.9.2.3
treeblank treeblank treetree hl7:postalCode
0 .. 1 R Patient Contact's Postal Code / Preferred HP's Postal Code R1.8.2.4 / R1.9.2.4
treeblank treeblank treetree hl7:state
0 .. 1 R Patient Contact's State or Province / Preferred HP's State or Province R1.8.2.5 / R1.9.2.5
treeblank treeblank treetree hl7:country
0 .. 1 R Patient Contact's Country / Preferred HP's Country. When used addr.country it is always bound to the epSOSCountry value set R1.8.2.6 / R1.9.2.6
treeblank treetree hl7:telecom
TEL 1 .. * R Patient Contact's / Preferred HP's/Legal Organization telephone or e-mail <telecom> element is required. If there is no information, the nullFlavor attribute shall have a value of 'UNK' 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 R1.8.4.1 / R1.8.4.2 / R1.9.3.1 / R1.9.3.2
treeblank treeblank treetree @use
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 epSOSTelecomAddress (DYNAMIC)
treeblank treeblank treetree @nullFlavor
0 .. 1 F UNK
  Example <telecom use="WP" value="tel:+45 20 7025 6161"/>
<telecom use="HP" value="mailto:jsmith@myprovider.co.uk"/>
Choice min 1 element(s) and max 1 element(s). Elements to choose from:
  • hl7:associatedPerson
  • hl7:scopingOrganization
treeblank treeblank treetree hl7:associatedPerson
R (epSOSCDAContactOrPreferredHP)
treeblank treeblank treeblank treetree hl7:name
PN 1 .. 1 R Patient Contact's Name / Preferred HP's Name IHE PCC / R1.9.1
  Example <name>
  <given>John</given>  <family>Español Smith</family></name>
Choice min 1 element(s) and max * element(s). Elements to choose from:
  • hl7:family
  • hl7:given
treeblank treeblank treeblank treeblank treeblank treetree hl7:family
1 .. * R Patient Contact's Family Name/Surname / Preferred HP's Family Name/Surname R1.8.1 / R1.9.1.1
treeblank treeblank treeblank treeblank treeblank treetree hl7:given
1 .. * R Patient Contact's Given Name / Preferred HP's Given Name R1.8.2 / R1.9.1.2
treeblank treeblank treetree hl7:scopingOrganization
R (epSOSCDAContactOrPreferredHP)
treeblank treeblank treeblank treetree hl7:name
ON 1 .. 1 R Organization's Name R1.9.1