Back To Index  <<  Back To Templates

pending Template  IPS Patient Contacts

Id 2.16.840.1.113883.10.22.2.5 Effective Date 2017‑04‑12
Status pending Under pre-publication review Version Label STU1
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)
Associated with
Associated with 8 concepts
Id Name Data Set
hl7ips-dataelement-154 draft Patient’s Address Book draft CEN/TC 251 prEN 17269
hl7ips-dataelement-174 draft Telecoms draft CEN/TC 251 prEN 17269
hl7ips-dataelement-163 draft Preferred Healthcare providers draft CEN/TC 251 prEN 17269
hl7ips-dataelement-165 draft Healthcare Provider (person) draft CEN/TC 251 prEN 17269
hl7ips-dataelement-166 draft Healthcare Provider (organisation) draft CEN/TC 251 prEN 17269
hl7ips-dataelement-169 draft Telecoms draft CEN/TC 251 prEN 17269
hl7ips-dataelement-121 draft Name draft CEN/TC 251 prEN 17269
hl7ips-dataelement-172 draft Organisation’s Name draft CEN/TC 251 prEN 17269
Used by / Uses
Used by 1 transaction and 2 templates, Uses 1 template
Used by as Name Version
hl7ips-transaction-2 Transaction draft IPS Created 2017‑04‑07 11:10:54
2.16.840.1.113883.10.22.1.1 Include draft International Patient Summary 2020‑05‑08 12:30:59
2.16.840.1.113883.10.22.1.1 Include pending International Patient Summary (STU1) 2017‑04‑11
Uses as Name Version
2.16.840.1.113883.10.22.11 Include pending IPS Address (STU1) DYNAMIC
Relationship Adaptation: template 2.16.840.1.113883.10.12.108 CDA participant (DYNAMIC)
ref
ad1bbr-

Adaptation: template 1.3.6.1.4.1.19376.1.5.3.1.2.4 IHE Patient Contacts (DYNAMIC)
ref
IHE-PCC-
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. (IPSdotscts)
where [hl7:templateId/@root='2.16.840.1.113883.10.22.2.5']
 
target
hl7ips-dataelement-154 draft Patient’s Address Book draft CEN/TC 251 prEN 17269
hl7ips-dataelement-163 draft Preferred Healthcare providers draft CEN/TC 251 prEN 17269
@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 (IPSdotscts)
@root
 		uid 1 … 1 F 2.16.840.1.113883.10.22.2.5
hl7:functionCode
 		0 … 1 C The   element may be used to indicate that this participant is the preferred Health Professional to contact in case of emergency. (IPSdotscts)
@code
 		CONF 0 … 1 F PCP
@codeSystem
 		0 … 1 F 2.16.840.1.113883.5.88 (Participation Function)
hl7:associatedEntity
 		R The element identifies the type of contact.  (IPSdotscts)
@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. (IPSdotscts)
  CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.11.22.54 IPS Personal Relationship (DYNAMIC)
or
The value of @code shall be drawn from value set 2.16.840.1.113883.11.22.53 IPS Healthcare Professional Roles (DYNAMIC)
  Example <code code="AUNT" displayName="θεία" codeSystem="2.16.840.1.113883.5.111"/>
hl7:addr
 		AD.IPS 1 … * R Patient Contact's / Preferred HP's Address (IPSdotscts)
  Schematron assert role red error  
  test @nullFlavor or hl7:*  
  Message If addr is not nullflavored at least one sub element has to be provided  
Included from 2.16.840.1.113883.10.22.11 IPS Address (DYNAMIC)
@use
 		set_cs 0 … 1  
  CONF
The value of @use shall be drawn from value set 2.16.840.1.113883.1.11.10637 PostalAddressUse (2005‑05‑01)
@nullFlavor
 		cs 0 … 1 F NI
  Constraint SHALL NOT have mixed content except for white space
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.
  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
 		ADXP 0 … * C Subject's or Organization's Street Address Line (IPSdotscts)
  Schematron assert role red error  
  test hl7:streetAddressLine and (hl7:city or hl7:postalCode)  
  Message If the address line is included either the city or the zip code has to be provided  
hl7:city
 		ADXP 0 … 1 C Subject's or Organization's City (IPSdotscts)
hl7:postalCode
 		ADXP 0 … 1 C Subject's or Organization's Postal Code (IPSdotscts)
hl7:state
 		ADXP 0 … 1 C Subject's or Organization's State or Province (IPSdotscts)
hl7:country
 		ADXP 0 … 1 C Subject's Country. (IPSdotscts)
  Constraint The content of this element SHALL be selected EITHER from ValueSet ISO Country Alpha-2 urn:oid:2.16.840.1.113883.1.11.20300  DYNAMIC OR MAY be selected from ISO Country Alpha-3 2.16.840.1.113883.1.11.171 DYNAMIC, IF the country is not specified in ValueSet ISO Country Alpha-2 urn:oid:2.16.840.1.113883.1.11.20300.
hl7:telecom
 		TEL 1 … * R Patient Contact's / Preferred HP's/Legal Organization telephone or e-mail element is required. (IPSdotscts)
 
target
hl7ips-dataelement-174 draft Telecoms draft CEN/TC 251 prEN 17269
hl7ips-dataelement-169 draft Telecoms draft CEN/TC 251 prEN 17269
@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 <telecom use="WP" value="tel:+45 20 7025 6161"/><telecom use="HP" value="mailto:jsmith@myprovider.co.uk"/>
Choice 1 … 2 Elements to choose from:
  • hl7:associatedPerson
  • hl7:scopingOrganization
hl7:associatedPerson
 		0 … 1 C Or the associatedPerson, or the scopingOrganization, or both elements shall be provided (IPSdotscts)
 
target
hl7ips-dataelement-165 draft Healthcare Provider (person) draft CEN/TC 251 prEN 17269
hl7:name
 		PN 1 … * R Patient Contact's Name / Preferred HP's Name (IPSdotscts)
 
target
hl7ips-dataelement-121 draft Name draft CEN/TC 251 prEN 17269
  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 (IPSdotscts)
hl7:given
 		1 … * R Patient Contact's Given Name / Preferred HP's Given Name (IPSdotscts)
hl7:scopingOrganization
 		0 … 1 C Or the associatedPerson, or the scopingOrganization, or both elements shall be provided (IPSdotscts)
 
target
hl7ips-dataelement-166 draft Healthcare Provider (organisation) draft CEN/TC 251 prEN 17269
hl7:name
 		ON 1 … * R Organization's Name (IPSdotscts)
 
target
hl7ips-dataelement-172 draft Organisation’s Name draft CEN/TC 251 prEN 17269