Template

Show index

Template IPS CDA recordTarget 2017‑04‑11

Id2.16.840.1.113883.10.22.2.1Effective Date2017‑04‑11
Statuspending Under pre-publication reviewVersion LabelSTU1
NameIPSCDArecordTargetDisplay NameIPS 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.
ClassificationCDA Header Level Template
Open/ClosedOpen (other than defined elements are allowed)
Associated with
Associated with 9 concepts
IdNameData Set
hl7ips-dataelement-2.1draft Patient Attributes draft CEN/TC 251 prEN 17269
hl7ips-dataelement-3draft Patient's name draft CEN/TC 251 prEN 17269
hl7ips-dataelement-7draft Insurance identifier draft CEN/TC 251 prEN 17269
hl7ips-dataelement-5draft Date of birth draft CEN/TC 251 prEN 17269
hl7ips-dataelement-202draft Healthcare related Identifiers draft CEN/TC 251 prEN 17269
hl7ips-dataelement-4draft Administrative gender draft CEN/TC 251 prEN 17269
hl7ips-dataelement-162draft Address draft CEN/TC 251 prEN 17269
hl7ips-dataelement-100draft Telecoms draft CEN/TC 251 prEN 17269
hl7ips-dataelement-135draft Patient’s preferred language draft CEN/TC 251 prEN 17269
Used by / Uses
Used by 0 transactions and 0 templates, Uses 1 template
Uses as NameVersion
2.16.840.1.113883.10.22.11Includepending IPS Address (STU1)DYNAMIC
RelationshipAdaptation: template 2.16.840.1.113883.3.1937.777.11.10.100 epSOS CDA recordTarget (2013‑12‑20)
ref
epsos-

Adaptation: template 2.16.840.1.113883.10.12.101 CDA recordTarget (2005‑09‑07)
ref
ad1bbr-
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>
ItemDTCardConfDescriptionLabel
hl7:recordTarget
1 … *RIPSCdotsrget
@typeCode
cs0 … 1FRCT
@contextControlCode
cs0 … 1FOP
 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 … 1MIPSCdotsrget
 
target
hl7ips-dataelement-2.1draft Patient Attributes draft CEN/TC 251 prEN 17269
@classCode
cs0 … 1FPAT
hl7:id
II1 … *RPatient Identifiers: Primary Patient Identifier (Regional/National Health Id), Secondary Patient Identifier (Social/Insurance Number)IPSCdotsrget
 
target
hl7ips-dataelement-7draft Insurance identifier draft CEN/TC 251 prEN 17269
hl7ips-dataelement-202draft Healthcare related Identifiers draft CEN/TC 251 prEN 17269
hl7:addr
AD.IPS1 … *RThe patient address.IPSCdotsrget
 
target
hl7ips-dataelement-162draft Address draft CEN/TC 251 prEN 17269
 ConstraintWhen used for cross-border exchange the country address part has to be provided.
Included from 2.16.840.1.113883.10.22.11 IPS Address (DYNAMIC)
@use
set_cs0 … 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
cs0 … 1FNI
 ConstraintSHALL 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 assertrolered error 
 test@nullFlavor or hl7:* 
 MessageIf addr is not nullflavored at least one sub element has to be provided 
hl7:streetAddressLine
ADXP0 … *CSubject's or Organization's Street Address LineIPSAdotsress
 Schematron assertrolered error 
 testhl7:streetAddressLine and (hl7:city or hl7:postalCode) 
 MessageIf the address line is included either the city or the zip code has to be provided 
hl7:city
ADXP0 … 1CSubject's or Organization's CityIPSAdotsress
hl7:postalCode
ADXP0 … 1CSubject's or Organization's Postal CodeIPSAdotsress
hl7:state
ADXP0 … 1CSubject's or Organization's State or ProvinceIPSAdotsress
hl7:country
ADXP0 … 1CSubject's Country.IPSAdotsress
 ConstraintThe 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
TEL1 … *RPatient’s telecom information : e.g. telephone number, e-mail address. IPSCdotsrget
 
target
hl7ips-dataelement-100draft Telecoms draft CEN/TC 251 prEN 17269
@use
set_cs0 … 1 
 CONF
The value of @use shall be drawn from value set 2.16.840.1.113883.1.11.201 TelecommunicationAddressUse (DYNAMIC)
@nullFlavor
cs0 … 1FNI
 ConstraintIf 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 … 1MIPSCdotsrget
@classCode
cs0 … 1FPSN
@determinerCode
cs0 … 1FINSTANCE
 Example
Japanese example (Person Name)
<patient>
  <name use="IDE">
    <family>木村</family>    <given>通男</given>  </name>  <name use="SYL">
    <family>きむら</family>    <given>みちお</given>  </name>  <name use="ABC">
    <family>KIMURA</family>    <given>MICHIO</given>  </name>  <administrativeGenderCode code="M" codeSystem="2.16.840.1.113883.5.1" displayName="Male"/>  <birthTime nullFlavor="UNK"/></patient>
hl7:name
PN1 … *MPatient NameIPSCdotsrget
 
target
hl7ips-dataelement-3draft Patient's name draft CEN/TC 251 prEN 17269
 ConstraintThe Alphabetic representation of the name SHALL be always provided
hl7:family
1 … *RPatient's Family Name/SurnameIPSCdotsrget
hl7:given
1 … *RPatient's Given NameIPSCdotsrget
hl7:administrativeGenderCode
CE.IPS1 … 1RPatient's GenderIPSCdotsrget
 
target
hl7ips-dataelement-4draft Administrative gender draft CEN/TC 251 prEN 17269
@nullFlavor
cs0 … 1FUNK
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.1 Administrative Gender (HL7 V3) (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
TS1 … 1RPatient's Date of Birth. The patient date of birth may be a partial date such as only the year.IPSCdotsrget
 
target
hl7ips-dataelement-5draft Date of birth draft CEN/TC 251 prEN 17269
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.

IPSCdotsrget
@classCode
cs1 … 1FGUARD
 Example<guardian classCode="GUARD">
  <code code="AUNT" displayName="tante" codeSystem="2.16.840.1.113883.5.111"/>  <addr nullFlavor="NI"/>  <telecom use="MC" value="tel:+33-12345678"/>  <guardianPerson>
    <name>
      <family>Curie</family>      <given>Marie</given>    </name>  </guardianPerson></guardian>
hl7:code
CD.IPS0 … 1RThe relationship between the patient and the guardian or other contact may be recorded in the element. IPSCdotsrget
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.19563 PersonalRelationshipRoleType (DYNAMIC)
hl7:addr
AD.IPS1 … *RIPSCdotsrget
 ConstraintIf 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.
Included from 2.16.840.1.113883.10.22.11 IPS Address (DYNAMIC)
@use
set_cs0 … 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
cs0 … 1FNI
 ConstraintSHALL 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 assertrolered error 
 test@nullFlavor or hl7:* 
 MessageIf addr is not nullflavored at least one sub element has to be provided 
hl7:streetAddressLine
ADXP0 … *CSubject's or Organization's Street Address LineIPSAdotsress
 Schematron assertrolered error 
 testhl7:streetAddressLine and (hl7:city or hl7:postalCode) 
 MessageIf the address line is included either the city or the zip code has to be provided 
hl7:city
ADXP0 … 1CSubject's or Organization's CityIPSAdotsress
hl7:postalCode
ADXP0 … 1CSubject's or Organization's Postal CodeIPSAdotsress
hl7:state
ADXP0 … 1CSubject's or Organization's State or ProvinceIPSAdotsress
hl7:country
ADXP0 … 1CSubject's Country.IPSAdotsress
 ConstraintThe 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
TEL1 … *RGuardian’s telecom information: e.g. telephone number; e-mail address. IPSCdotsrget
@use
set_cs0 … 1 
 CONF
The value of @use shall be drawn from value set 2.16.840.1.113883.1.11.201 TelecommunicationAddressUse (DYNAMIC)
@nullFlavor
cs0 … 1FNI
 ConstraintIf 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 … 1RIPSCdotsrget
hl7:name
PN1 … *RPatient Guardian's NameIPSCdotsrget
hl7:family
ENXP1 … *RPatient Guardian's Family Name/SurnameIPSCdotsrget
hl7:given
ENXP1 … *RPatient Guardian's Given NameIPSCdotsrget
hl7:languageCommunication
0 … *RIPSCdotsrget
hl7:languageCode
CS1 … 1RPatient’s languageIPSCdotsrget
 
target
hl7ips-dataelement-135draft Patient’s preferred language draft CEN/TC 251 prEN 17269
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.11.22.19 Language Code (DYNAMIC)
 Example
British English
<languageCode code="en-GB"/>
 Example
Amurdak (Australia)
<languageCode code="amg-AU"/>
 Schematron assertrolered error 
 testmatches(@code,'[a-z]{2,3}-[A-Z]{2,3}') 
 MessageThe language code SHALL be in the form nn-CC or nnn-CCC, in accordance with BCP 47 (e.g. nn is the ISO country code; CC is ISO language code)