2.16.840.1.113883.10.22.2.1/static-2020-07-14T165608

From HL7 IPS
Revision as of 14:14, 5 January 2021 by ADbot (talk | contribs) (Automatic ADBot page (7faf38be0c1db29a7bd481330339fbbcc5b312dd))
Jump to: navigation, search
Id2.16.840.1.113883.10.22.2.1||Effective Date2020‑07‑14 16:56:08
Other versions this id:
  • Kblank.png
StatusKyellow.png DraftVersion 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-data​element-2.1Kyellow.png Patient Attributes 0Kyellow.png
hl7ips-data​element-3Kyellow.png Patient's name 0Kyellow.png
hl7ips-data​element-7Kyellow.png Insurance identifier 0Kyellow.png
hl7ips-data​element-5Kyellow.png Date of birth 0Kyellow.png
hl7ips-data​element-202Kyellow.png Healthcare related Identifiers 0Kyellow.png
hl7ips-data​element-4Kyellow.png Administrative gender 0Kyellow.png
hl7ips-data​element-162Kyellow.png Address 0Kyellow.png
hl7ips-data​element-100Kyellow.png Telecoms 0Kyellow.png
hl7ips-data​element-135Kyellow.png Patient’s preferred language 0Kyellow.png
Uses
Uses 1 template
Uses as NameVersion
2.16.840.1.113883.10.22.11IncludeKorange.png IPS Address (STU1)DYNAMIC
RelationshipAdaptation: templateAdaptation: template
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)
 
Target.png
hl7ips-data​element-2.1Kyellow.png Patient Attributes Kyellow.png
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)
 
Target.png
hl7ips-data​element-7Kyellow.png Insurance identifier Kyellow.png
hl7ips-data​element-202Kyellow.png Healthcare related Identifiers Kyellow.png
Treeblank.pngTreetree.pnghl7:addr
AD.IPS1 … *RThe patient address.(IPS...get)
 
Target.png
hl7ips-data​element-162Kyellow.png Address Kyellow.png
 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)
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.10637 PostalAddressUse (2005‑05‑01)
Treeblank.pngTreeblank.pngTreetree.png@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 assertrole error 
 test@nullFlavor or hl7:* 
 MessageIf addr is not nullflavored at least one sub element has to be provided 
Treeblank.pngTreeblank.pngTreetree.pnghl7:streetAddressLine
ADXP0 … *CSubject's or Organization's Street Address Line(IPS...get)
 Schematron assertrole 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 
Treeblank.pngTreeblank.pngTreetree.pnghl7:city
ADXP0 … 1CSubject's or Organization's City(IPS...get)
Treeblank.pngTreeblank.pngTreetree.pnghl7:postalCode
ADXP0 … 1CSubject's or Organization's Postal Code(IPS...get)
Treeblank.pngTreeblank.pngTreetree.pnghl7:state
ADXP0 … 1CSubject's or Organization's State or Province(IPS...get)
Treeblank.pngTreeblank.pngTreetree.pnghl7:country
ADXP0 … 1CSubject's Country.(IPS...get)
 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.
Treeblank.pngTreetree.pnghl7:telecom
TEL1 … *RPatient’s telecom information : e.g. telephone number, e-mail address. (IPS...get)
 
Target.png
hl7ips-data​element-100Kyellow.png Telecoms Kyellow.png
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
 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>
Treeblank.pngTreeblank.pngTreetree.pnghl7:name
PN1 … *MPatient Name(IPS...get)
 
Target.png
hl7ips-data​element-3Kyellow.png Patient's name Kyellow.png
 ConstraintThe Alphabetic representation of the name SHALL be always provided
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:family
1 … *RPatient's Family Name/Surname(IPS...get)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:given
1 … *RPatient's Given Name(IPS...get)
Treeblank.pngTreeblank.pngTreetree.pnghl7:administrative​Gender​Code
CE.IPS1 … 1RPatient's Gender(IPS...get)
 
Target.png
hl7ips-data​element-4Kyellow.png Administrative gender Kyellow.png
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 … 1RPatient's Date of Birth. The patient date of birth may be a partial date such as only the year.(IPS...get)
 
Target.png
hl7ips-data​element-5Kyellow.png Date of birth Kyellow.png
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="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>
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:code
CD.IPS0 … 1RThe relationship between the patient and the guardian or other contact may be recorded in the 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 … *R(IPS...get)
 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)
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.10637 PostalAddressUse (2005‑05‑01)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@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 assertrole error 
 test@nullFlavor or hl7:* 
 MessageIf addr is not nullflavored at least one sub element has to be provided 
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:streetAddressLine
ADXP0 … *CSubject's or Organization's Street Address Line(IPS...get)
 Schematron assertrole 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 
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:city
ADXP0 … 1CSubject's or Organization's City(IPS...get)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:postalCode
ADXP0 … 1CSubject's or Organization's Postal Code(IPS...get)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:state
ADXP0 … 1CSubject's or Organization's State or Province(IPS...get)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:country
ADXP0 … 1CSubject's Country.(IPS...get)
 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.
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)
 
Target.png
hl7ips-data​element-135Kyellow.png Patient’s preferred language Kyellow.png
 ConstraintThe two characters form SHALL be used when available; otherwise the three characters representation SHALL be adopted
 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 assertrole 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 language code; CC is ISO country code)