Back To Index  <<  Back To Templates

ref Template  IPS Patient Contacts

Id 2.16.840.1.113883.10.22.2.5 Effective Date valid from 2017‑04‑12
Status draft Draft Version Label
Name IPSCDAContacts Display Name IPS Patient Contacts
Description
The IPS may record several kinds of patient contacts, including parents, relatives, caregivers, and others related in some way to the patient.
A patient contact may be an individual or an organization with a relationship to the patient, including health provider (person or organization) to be contacted in case of emergency.
Classification CDA Header Level Template
Open/Closed Open (other than defined elements are allowed)
Used by / Uses
Used by 0 transactions and 1 template, Uses 0 templates
Used by as Name Version
2.16.840.1.113883.10.22.1.1 Include draft International Patient Summary 2017‑04‑11
Relationship Adaptation: 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)
Example
Contact person
<participant typeCode="IND">
  <templateId root="2.16.840.1.113883.10.22.2.5"/>  <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 Health Professional for emergency contact
<participant typeCode="IND">
  <templateId root="2.16.840.1.113883.10.22.2.5"/>  <functionCode code="PCP" codeSystem="2.16.840.1.113883.5.88"/>  <time value="20070213"/>  <associatedEntity classCode="ECON">
    <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>
Item DT Card Conf Description Label
hl7:participant
 R Patient contacts or the Preferred Health Professional to contact in case of emergency. (IPS…cts)
where [hl7:templateId/@root='2.16.840.1.113883.10.22.2.5']
@typeCode
 cs 1 … 1 F IND
  Example <participant typeCode="IND">
  <templateId root="2.16.840.1.113883.10.22.2.5"/>  <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>
hl7:templateId
 II 1 … 1 M (IPS…cts)
@root
 uid 1 … 1 F 2.16.840.1.113883.10.22.2.5
hl7:functionCode
 0 … 1 C The  <functionCode> element may be used to indicate that this participant is the preferred Health Professional to contact in case of emergency. (IPS…cts)
@code
 CONF 1 … 1 F PCP
@codeSystem
 1 … 1 F 2.16.840.1.113883.5.88 (Participation Function)
hl7:time
 IVL_TS.IPS.TZ.OPT 0 … 1 R The <time> element may be present and indicates the time of the participation. (IPS…cts)
  Example
Precision Day
<time value="20070213"/>
  Example
Precision minute (requires timezone)
<time value="200702131234+0100"/>
hl7:associatedEntity
 R The <associatedEntity> element identifies the type of contact.  (IPS…cts)
@classCode
 cs 1 … 1 R
  CONF
The value of @classCode shall be drawn from value set 2.16.840.1.113883.11.20.9.33 INDRoleclassCodes (DYNAMIC)
  Example <associatedEntity classCode="ECON">
  <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>
hl7:code
 CV.IPS 0 … 1 R This element indicates the relationship between the patient and this participant.
 (IPS…cts)
  CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.11.22.54 IPS Personal Relationship (DYNAMIC)
  Example <code code="AUNT" displayName="θεία" codeSystem="2.16.840.1.113883.5.111"/>
hl7:addr
 AD.IPS 1 … 1 R Patient Contact's / Preferred HP's Address (IPS…cts)
@nullFlavor
 cs 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  
hl7:streetAddressLine
 0 … * R Patient Contact's Street/Number of Street / Preferred HP's Street/Number of Street (IPS…cts)
hl7:city
 0 … 1 R Patient Contact's City / Preferred HP's City (IPS…cts)
hl7:postalCode
 0 … 1 R Patient Contact's Postal Code / Preferred HP's Postal Code (IPS…cts)
hl7:state
 0 … 1 R Patient Contact's State or Province / Preferred HP's State or Province (IPS…cts)
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 (IPS…cts)
hl7:telecom
 TEL 1 … * R Patient Contact's / Preferred HP's/Legal Organization telephone or e-mail <telecom> element is required. (IPS…cts)
@use
 set_cs 0 … 1  
  CONF
The value of @use shall be drawn from value set 2.16.840.1.113883.1.11.201 TelecommunicationAddressUse (DYNAMIC)
@nullFlavor
 cs 0 … 1 F NI
  Constraint 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
  Example <art:placeholder>
  <telecom use="WP" value="tel:+45 20 7025 6161"/>  <telecom use="HP" value="mailto:jsmith@myprovider.co.uk"/></art:placeholder>
Choice 1 … 2 Elements to choose from:
  • hl7:associatedPerson
  • hl7:scopingOrganization
hl7:associatedPerson
 0 … 1 C (IPS…cts)
hl7:name
 PN 1 … 1 R Patient Contact's Name / Preferred HP's Name (IPS…cts)
  Example <name>
  <given>John</given>  <family>Español Smith</family></name>
hl7:family
 1 … * R Patient Contact's Family Name/Surname / Preferred HP's Family Name/Surname (IPS…cts)
hl7:given
 1 … * R Patient Contact's Given Name / Preferred HP's Given Name (IPS…cts)
hl7:scopingOrganization
 0 … 1 C (IPS…cts)
hl7:name
 ON 1 … 1 R Organization's Name (IPS…cts)