Back To Index  <<  Back To Templates

ref Template  IPS CDA recordTarget

Id 2.16.840.1.113883.10.22.2.1 Effective Date valid from 2017‑04‑11
Status draft Draft Version Label
Name IPSCDArecordTarget Display Name IPS CDA recordTarget
Description
The recordTarget records the administrative and demographic data of the patient whose health information is described by the clinical document; each recordTarget must contain at least one patientRole element.
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.3.1937.777.11.10.100 (2013‑12‑20)
Adaptation: template 2.16.840.1.113883.10.12.101 (2005‑09‑07)
Example
Example
<recordTarget typeCode="RCT" contextControlCode="OP">
  <patientRole classCode="PAT">
    <id root="1.2.3.999" extension="__example only__"/>    <addr>
      <streetAddressLine>HSE M CASSAR STR</streetAddressLine>      <city>ISLA</city>      <country>MT</country>    </addr>    <telecom use="HP" value="tel:+356124567891"/>    <telecom use="WP" value="mailto:elif@foo.too.mt"/>    <patient>
      <name>
        <family>BORG</family>        <given>TANIA</given>      </name>      <administrativeGenderCode code="F" codeSystem="2.16.840.1.113883.5.1" displayName="Female"/>      <birthTime value="19430130"/>      <!-- Optional guardian information ; see example below-->
      <!-- Optional languageCommunication information see example below -->
    </patient>  </patientRole></recordTarget>
Item DT Card Conf Description Label
hl7:recordTarget
 1 … * R (IPS…get)
@typeCode
 cs 0 … 1 F RCT
@contextControlCode
 cs 0 … 1 F OP
  Example <recordTarget typeCode="RCT" contextControlCode="OP">
  <patientRole classCode="PAT">
    <id root="1.2.3.999" extension="__example only__"/>    <addr>
      <streetAddressLine>HSE M CASSAR STR</streetAddressLine>      <city>ISLA</city>      <country>MT</country>    </addr>    <telecom use="HP" value="tel:+356124567891"/>    <telecom use="WP" value="mailto:elif@foo.too.mt"/>    <patient>
      <name>
        <family>BORG</family>        <given>TANIA</given>      </name>      <administrativeGenderCode code="F" codeSystem="2.16.840.1.113883.5.1" displayName="Female"/>      <birthTime value="19430130"/>      <!-- Optional guardian information ; see example below-->
      <!-- Optional languageCommunication information see example below -->
    </patient>  </patientRole></recordTarget>
hl7:patientRole
 1 … 1 M (IPS…get)
@classCode
 cs 0 … 1 F PAT
hl7:id
 II 1 … * R Patient Identifiers: Primary Patient Identifier (Regional/National Health Id), Secondary Patient Identifier (Social/Insurance Number) (IPS…get)
hl7:addr
 AD.IPS 1 … 1 R The patient address.
 (IPS…get)
@nullFlavor
 cs 0 … 1 F NI
  Constraint 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.
  Example <addr use="HP">
  <country>TR</country>  <city>Ankara</city>  <streetAddressLine>Silikon Blok Kat:1</streetAddressLine></addr>
  Example <addr use="WP">
  <state>FI</state>  <city>FIRENZE</city>  <country>IT</country>  <postalCode>50122</postalCode>  <streetAddressLine>Palazzo Vecchio, Piazza della Signoria</streetAddressLine></addr>
  Example <addr nullFlavor="NI"/>
hl7:streetAddressLine
 0 … * C Patient's Number of Street/Patient's Number of Street (IPS…get)
hl7:city
 0 … 1 C Patient's City (IPS…get)
hl7:postalCode
 0 … 1 C Patient's Postal Code (IPS…get)
hl7:state
 0 … 1 C Patient's State or Province (IPS…get)
hl7:country
 0 … 1 C Patient's Country. (IPS…get)
hl7:telecom
 TEL 1 … * R Patient’s telecom information : e.g. telephone number, e-mail address.  (IPS…get)
@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="HP" value="tel:+356124567891"/>
  Example <telecom use="WP" value="mailto:elif@foo.too.mt"/>
  Example <telecom nullFlavor="NI"/>
hl7:patient
 1 … 1 M (IPS…get)
@classCode
 cs 0 … 1 F PSN
@determinerCode
 cs 0 … 1 F INSTANCE
hl7:name
 PN 1 … * R Patient Name (IPS…get)
hl7:family
 1 … * M Patient's Family Name/Surname (IPS…get)
hl7:given
 1 … * M Patient's Given Name (IPS…get)
hl7:administrativeGenderCode
 CE.IPS 1 … 1 R Patient's Gender (IPS…get)
@nullFlavor
 cs 0 … 1 F UNK
  CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.1 AdministrativeGender (DYNAMIC)
  Example <administrativeGenderCode code="F" codeSystem="2.16.840.1.113883.5.1" displayName="Female">
  <translation code="2" codeSystem="2.16.840.1.113883.3.129.1.2.21" codeSystemName="Cinsiyet" displayName="Kadın"/></administrativeGenderCode>
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. (IPS…get)
hl7:guardian
 0 … * R

The guardians of a patient.

Other patient contacts are described using the /ClinicalDocument/participant structure. The <associatedEntity> element defines the type of contact.

(IPS…get)
@classCode
 cs 1 … 1 F GUARD
  Example <guardian classCode="GUARD">
  <code code="AUNT" displayName="aunt" codeSystem="2.16.840.1.113883.5.111">
    <translation displayName="tante"/>  </code>  <addr nullFlavor="NI"/>  <telecom use="MC" value="tel:+33-12345678"/>  <guardianPerson>
    <name>
      <family>Curie</family>      <given>Marie</given>    </name>  </guardianPerson></guardian>
hl7:code
 CD.IPS 0 … 1 R The relationship between the patient and the guardian or other contact may be recorded in the <code> element. 
 (IPS…get)
  CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.19563 PersonalRelationshipRoleType (DYNAMIC)
hl7:addr
 AD.IPS 1 … 1 R (IPS…get)
@nullFlavor
 cs 0 … 1 F NI
  Constraint 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.
hl7:streetAddressLine
 0 … * R Guardian's Number of Street/Guardian's Number of Street (IPS…get)
hl7:city
 0 … 1 R Guardian's City (IPS…get)
hl7:postalCode
 0 … 1 R Guardian's Postal Code (IPS…get)
hl7:state
 0 … 1 R Guardian's State or Province (IPS…get)
hl7:country
 0 … 1 R Guardian's Country. (IPS…get)
hl7:telecom
 TEL 1 … * R Guardian’s telecom information: e.g. telephone number; e-mail address.  (IPS…get)
@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.
hl7:guardianPerson
 1 … 1 R (IPS…get)
hl7:name
 PN 1 … * R Patient Guardian's Name (IPS…get)
hl7:family
 ENXP 1 … * R Patient Guardian's Family Name/Surname
 (IPS…get)
hl7:given
 ENXP 1 … * R Patient Guardian's Given Name
 (IPS…get)
hl7:languageCommunication
 0 … * R (IPS…get)
hl7:languageCode
 CS 1 … 1 R Patient’s language (IPS…get)
  CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.11.22.19 Language Code (2017‑04‑11)
  Example
British English
<languageCode code="en-GB"/>
  Example
Amurdak (Australia)
<languageCode code="amg-AU"/>
  Schematron assert role red error  
  test matches(@code,'[a-z]{2,3}-[A-Z]{2}')  
  Message The language code SHALL be in the form nn-CC where nn is ISO-639-1 and CC is ISO-3166