2.16.840.1.113883.10.22.2.1/static-2017-04-11T000000

From HL7 IPS
Revision as of 16:15, 24 July 2017 by ADbot (talk | contribs) (Automated ADBot page content)
Jump to: navigation, search
Id2.16.840.1.113883.10.22.2.1Effective Date valid from 2017‑04‑11
StatusKyellow.png DraftVersion Label
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)
Used by / Uses
Used by 0 transactions and 1 template, Uses 0 templates
Used by as NameVersion
2.16.840.1.113883.10.22.1.1IncludeKyellow.png International Patient Summary2017‑04‑11
RelationshipAdaptation: 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>
ItemDTCardConfDescriptionLabel
hl7:recordTarget
1 … *R(IPS…get)
Treetree.png@typeCode
cs0 … 1FRCT
Treetree.png@context​Control​Code
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>
Treetree.pnghl7:patientRole
1 … 1M(IPS…get)
Treeblank.pngTreetree.png@classCode
cs0 … 1FPAT
Treeblank.pngTreetree.pnghl7:id
II1 … *RPatient Identifiers: Primary Patient Identifier (Regional/National Health Id), Secondary Patient Identifier (Social/Insurance Number)(IPS…get)
Treeblank.pngTreetree.pnghl7:addr
AD.IPS1 … 1RThe patient address.
(IPS…get)
Treeblank.pngTreeblank.pngTreetree.png@nullFlavor
cs0 … 1FNI
 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.
 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"/>
Treeblank.pngTreeblank.pngTreetree.pnghl7:streetAddressLine
0 … *CPatient's Number of Street/Patient's Number of Street(IPS…get)
Treeblank.pngTreeblank.pngTreetree.pnghl7:city
0 … 1CPatient's City(IPS…get)
Treeblank.pngTreeblank.pngTreetree.pnghl7:postalCode
0 … 1CPatient's Postal Code(IPS…get)
Treeblank.pngTreeblank.pngTreetree.pnghl7:state
0 … 1CPatient's State or Province(IPS…get)
Treeblank.pngTreeblank.pngTreetree.pnghl7:country
0 … 1CPatient's Country.(IPS…get)
Treeblank.pngTreetree.pnghl7:telecom
TEL1 … *RPatient’s telecom information : e.g. telephone number, e-mail address. (IPS…get)
Treeblank.pngTreeblank.pngTreetree.png@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)
Treeblank.pngTreeblank.pngTreetree.png@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"/>
Treeblank.pngTreetree.pnghl7:patient
1 … 1M(IPS…get)
Treeblank.pngTreeblank.pngTreetree.png@classCode
cs0 … 1FPSN
Treeblank.pngTreeblank.pngTreetree.png@determiner​Code
cs0 … 1FINSTANCE
Treeblank.pngTreeblank.pngTreetree.pnghl7:name
PN1 … *RPatient Name(IPS…get)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:family
1 … *MPatient's Family Name/Surname(IPS…get)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:given
1 … *MPatient's Given Name(IPS…get)
Treeblank.pngTreeblank.pngTreetree.pnghl7:administrative​Gender​Code
CE.IPS1 … 1RPatient's Gender(IPS…get)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.png@nullFlavor
cs0 … 1FUNK
 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>
Treeblank.pngTreeblank.pngTreetree.pnghl7:birthTime
TS1 … 1MPatient's Date of Birth. The patient date of birth may be a partial date such as only the year.(IPS…get)
Treeblank.pngTreeblank.pngTreetree.pnghl7: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)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FGUARD
 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>
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:code
CD.IPS0 … 1RThe 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)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:addr
AD.IPS1 … 1R(IPS…get)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@nullFlavor
cs0 … 1FNI
 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.
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:streetAddressLine
0 … *RGuardian's Number of Street/Guardian's Number of Street(IPS…get)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:city
0 … 1RGuardian's City(IPS…get)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:postalCode
0 … 1RGuardian's Postal Code(IPS…get)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:state
0 … 1RGuardian's State or Province(IPS…get)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:country
0 … 1RGuardian's Country.(IPS…get)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:telecom
TEL1 … *RGuardian’s telecom information: e.g. telephone number; e-mail address. (IPS…get)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@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)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@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.
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:guardian​Person
1 … 1R(IPS…get)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:name
PN1 … *RPatient Guardian's Name(IPS…get)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:family
ENXP1 … *RPatient Guardian's Family Name/Surname
(IPS…get)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:given
ENXP1 … *RPatient Guardian's Given Name
(IPS…get)
Treeblank.pngTreeblank.pngTreetree.pnghl7:language​Communication
0 … *R(IPS…get)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:language​Code
CS1 … 1RPatient’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 assertroleKred.png error 
 testmatches(@code,'[a-z]{2}-[A-Z]{2}') 
 MessageThe language code SHALL be in the form nn-CC where nn is ISO-639-1 and CC is ISO-3166