2.16.840.1.113883.10.22.1.2/static-2024-08-02T130239

From HL7 IPS
Jump to: navigation, search
Id2.16.840.1.113883.10.22.1.2Effective Date2024‑08‑02 13:02:39
Other versions this id:
  • Kblank.png HL7-IPS as of 2020‑07‑14 16:08:21
  • Kblank.png HL7-IPS as of 2020‑05‑08 12:30:59
  • Kblank.png HL7-IPS as of 2017‑04‑11
StatusKyellow.png DraftVersion Label2024
NameHL7-IPSDisplay NameInternational Patient Summary
Description

The International Patient Summary is a "Minimal and non-exhaustive Patient Summary, specialty-agnostic, condition-independent, but readily usable by all clinicians for the unscheduled (cross-border) care of a patient."

The IPS templates aim to:

  • Serve for both cross-jurisdictional (through adaptation/extension for multi-language and realm scenarios, including translation) and national (through localization) patient summaries.

  • Support emergency care and unplanned care in any country (home and foreign), regardless of language

  • Define value sets based on international vocabularies that are usable and understandable in any country  

ContextPathname /
ClassificationCDA Document Level Template
Open/ClosedOpen (other than defined elements are allowed)
Uses
Uses 23 templates
Used by as NameVersion
hl7ips-transaction-3TransactionKyellow.png IPS Created (2024)2024‑08‑02
Uses as NameVersion
2.16.840.1.113883.10.22.2.1IncludeKyellow.png IPS CDA recordTarget (2021)DYNAMIC
2.16.840.1.113883.10.22.2.2IncludeKorange.png IPS CDA author (STU1)DYNAMIC
2.16.840.1.113883.10.22.2.3IncludeKyellow.png IPS CDA custodian (2021)DYNAMIC
2.16.840.1.113883.10.22.2.4IncludeKorange.png IPS CDA legalAuthenticator (STU1)DYNAMIC
2.16.840.1.113883.10.22.2.5IncludeKorange.png IPS Patient Contacts (STU1)DYNAMIC
2.16.840.1.113883.10.22.2.6IncludeKorange.png IPS CDA documentationOf (STU1)DYNAMIC
2.16.840.1.113883.10.22.2.7IncludeKorange.png IPS CDA relatedDocument (STU1)DYNAMIC
2.16.840.1.113883.10.22.3.1ContainmentKorange.png IPS Medication Summary Section (STU1)DYNAMIC
2.16.840.1.113883.10.22.3.2ContainmentKyellow.png IPS Allergies and Intolerances Section (STU2)DYNAMIC
2.16.840.1.113883.10.22.3.3ContainmentKorange.png IPS Problems Section (STU1)DYNAMIC
2.16.840.1.113883.10.22.3.4ContainmentKorange.png IPS History of Procedures Section (STU1)DYNAMIC
2.16.840.1.113883.10.22.3.5ContainmentKorange.png IPS Immunizations Section (STU1)DYNAMIC
2.16.840.1.113883.10.22.3.6ContainmentKyellow.png IPS Medical Devices Section (2021)DYNAMIC
2.16.840.1.113883.10.22.3.14ContainmentKorange.png IPS Results Section (STU1)DYNAMIC
1.3.6.1.4.1.19376.1.5.3.1.1.5.3.2ContainmentKgreen.png IHE Coded Vital Signs Section (2014)DYNAMIC
2.16.840.1.113883.10.22.3.7ContainmentKorange.png IPS History of Past Illness Section (STU1)DYNAMIC
2.16.840.1.113883.10.22.3.8ContainmentKorange.png IPS Functional Status Section (TI-2020)DYNAMIC
2.16.840.1.113883.10.22.3.9ContainmentKorange.png IPS Plan of Care Section (TI-2020)DYNAMIC
2.16.840.1.113883.10.22.3.10ContainmentKorange.png IPS Social History Section (TI-2020)DYNAMIC
2.16.840.1.113883.10.22.3.11ContainmentKorange.png IPS History of Pregnancy Section (TI-2020)DYNAMIC
2.16.840.1.113883.10.22.3.12ContainmentKorange.png IPS Advance Directives Section (TI-2020)DYNAMIC
2.16.840.1.113883.10.22.15ContainmentKyellow.png IPS Alerts SectionDYNAMIC
2.16.840.1.113883.10.22.16ContainmentKyellow.png IPS Patient Story SectionDYNAMIC
RelationshipSpecialization: template 2.16.840.1.113883.10.22.1.1 International Patient Summary (2020‑07‑14 16:08:21)
Version: template 2.16.840.1.113883.10.22.1.1 International Patient Summary (2020‑05‑08 12:30:59)
Version: template 2.16.840.1.113883.10.22.1.1 International Patient Summary (2017‑04‑11)
Adaptation: template 1.3.6.1.4.1.12559.11.10.1.3.1.1.3 epSOS-Patient Summary (2013‑12‑20)
ref
epsos-

Adaptation: template 2.16.840.1.113883.10.12.1 CDA ClinicalDocument (2005‑09‑07)
ref
ad1bbr-
Example
Example
<ClinicalDocument>
  <realmCode code="ES"/>  <typeId extension="POCD_HD000040" root="2.16.840.1.113883.1.3"/>  <templateId root="2.16.840.1.113883.10.22.1.1"/>  <id root="2.16.724.4.8.10.200.10" extension="PSCTD0160f274530a031"/>  <code displayName="Patient Summary" code="60591-5" codeSystem="2.16.840.1.113883.6.1">
    <title>Patient Summary</title>    <effectiveTime value="20111113125600+0200"/>    <confidentialityCode code="N" displayName="normal" codeSystem="2.16.840.1.113883.5.25"/>    <languageCode code="es-ES"/>    <setId root="2.16.724.4.8.10.200.10" extension="PSCTD0160f274530a031S"/>    <versionNumber value="2"/>    <!-- include template 2.16.840.1.113883.10.22.2.1 'IPS CDA recordTarget' (dynamic) 1..1 M -->
    <!-- include template 2.16.840.1.113883.10.22.2.2 'IPS CDA author' (dynamic) 1..* M -->
    <!-- include template 2.16.840.1.113883.10.22.2.3 'IPS CDA custodian' (dynamic) 1..1 M -->
    <!-- include template 2.16.840.1.113883.10.22.2.4 'IPS CDA legalAuthenticator' (dynamic) 0..1 R -->
    <!-- include template 2.16.840.1.113883.10.22.2.5 'IPS Patient Contacts' (dynamic) 0..* O -->
    <!-- include template 2.16.840.1.113883.10.22.2.6 'IPS CDA documentationOf ' (dynamic) 1..1 M -->
    <!-- include template 2.16.840.1.113883.10.22.2.7 'IPS CDA relatedDocument' (dynamic) 0..* R -->
    <component>
      <structuredBody classCode="DOCBODY">
        <component>
          <!-- template 2.16.840.1.113883.10.22.3.1 'IPS Medication Summary Section' (dynamic) -->
        </component>        <component>
          <!-- template 2.16.840.1.113883.10.22.3.2 'IPS Allergies and Intolerances Section' (dynamic) -->
        </component>        <component>
          <!-- template 2.16.840.1.113883.10.22.3.3 'IPS Problems Section' (dynamic) -->
        </component>        <component>
          <!-- template 2.16.840.1.113883.10.22.3.4 'IPS History of Procedures Section' (dynamic) -->
        </component>        <component>
          <!-- template 2.16.840.1.113883.10.22.3.5 'IPS Immunizations Section' (dynamic) -->
        </component>        <component>
          <!-- template 2.16.840.1.113883.10.22.3.6 'IPS Medical Devices Section' (dynamic) -->
        </component>        <component>
          <!-- template 2.16.840.1.113883.10.22.3.7 'IPS History of Past Illness Section' (dynamic) -->
        </component>        <component>
          <!-- template 2.16.840.1.113883.10.22.3.14 'IPS Results Section' (dynamic) -->
        </component>        <component>
          <!-- template 2.16.840.1.113883.10.22.3.8 'IPS Functional Status Section' (dynamic) -->
        </component>        <component>
          <!-- template 2.16.840.1.113883.10.22.3.9 'IPS Plan of Treatment Section' (dynamic) -->
        </component>        <component>
          <!-- template 2.16.840.1.113883.10.22.3.10 'IPS Social History Section' (dynamic) -->
        </component>        <component>
          <!-- template 2.16.840.1.113883.10.22.3.11 'IPS History of Pregnancy Section' (dynamic) -->
        </component>        <component>
          <!-- template 2.16.840.1.113883.10.22.3.12 'IPS Advance Directives Section' (dynamic) -->
        </component>        <component>
          <!-- template 2.16.840.1.113883.10.22.15 'IPS Alerts Section' (dynamic) -->
        </component>        <component>
          <!-- template 2.16.840.1.113883.10.22.16 'IPS Patient Story Section' (dynamic) -->
        </component>      </structuredBody>    </component>  </code></ClinicalDocument>
ItemDTCardConfDescriptionLabel
hl7:ClinicalDocument
RCDA header(HL7-IPS)
Treetree.pnghl7:realmCode
CS0 … 1R(HL7-IPS)
Treetree.pnghl7:typeId
II1 … 1M The clinical document typeId identifies the constraints imposed by CDA R2 on the content, essentially acting as a version identifier.

(HL7-IPS)
Treeblank.pngTreetree.png@root
uid1 … 1F2.16.840.1.113883.1.3
Treeblank.pngTreetree.png@extension
st1 … 1FPOCD_HD000040
 Example<typeId extension="POCD_HD000040" root="2.16.840.1.113883.1.3"/>
Treetree.pnghl7:templateId
II1 … 1M(HL7-IPS)
Treeblank.pngTreetree.png@root
uid1 … 1F2.16.840.1.113883.10.22.1.1
Treetree.pnghl7:id
II1 … 1MUnique identifier of this instance of the Patient Summary.(HL7-IPS)
Treetree.pnghl7:code
CE.IPS1 … 1MDetermines the document type that is the "Patient Summary" document(HL7-IPS)
Treeblank.pngTreetree.png@displayName
1 … 1R
Treeblank.pngTreetree.png@code
CONF1 … 1F60591-5
Treeblank.pngTreetree.png@codeSystem
1 … 1F2.16.840.1.113883.6.1 (LOINC)
 Example<code code="60591-5" codeSystem="2.16.840.1.113883.6.1" codeSystemName="LOINC" displayName="Patient Summary"/>
Treeblank.pngTreetree.pnghl7:translation
CD.IPS0 … *RThis element can be here used either to provide the originally used document code if this IPS is the result of a transformation.(HL7-IPS)
Treetree.pnghl7:title
ST1 … 1MClinicalDocument/title is used for display purposes.(HL7-IPS)
Treetree.pnghl7:effectiveTime
TS.IPS.TZ1 … 1MTime of creation of the Patient Summary(HL7-IPS)
 Example<effectiveTime value="20111113125600+0200"/>
Treetree.pnghl7:confidentialityCode
CE.IPS1 … 1R(HL7-IPS)
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.16926 HL7 BasicConfidentialityKind (DYNAMIC)
 Example<confidentialityCode code="N" codeSystem="2.16.840.1.113883.5.25" displayName="normal"/>
Treetree.pnghl7:language​Code
CS1 … 1MDocument Language Code(HL7-IPS)
 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.4.642.3.21 All Languages (DYNAMIC)
 Example<languageCode code="en-GB"/>
 Example<languageCode code="fil-PH"/>
 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) 
Treetree.pnghl7:setId
II0 … 1R

This attribute “represents an identifier that is common across all document revisions”.

In the case the IPS instance is generated as result of one or more transformations (translation/transcoding) the setId is supposed to remain unchanged across all those transformations.

Implementers are recommended to use this attribute.

(HL7-IPS)
Treetree.pnghl7:versionNumber
0 … 1R(HL7-IPS)
Included1 … 1M from 2.16.840.1.113883.10.22.2.1 IPS CDA recordTarget (DYNAMIC)
Treetree.pnghl7:recordTarget
1 … 1M(HL7-IPS)
Treeblank.pngTreetree.png@typeCode
cs0 … 1FRCT
Treeblank.pngTreetree.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>
Treeblank.pngTreetree.pnghl7:patientRole
1 … 1M(HL7-IPS)
 
Target.png
hl7ips-data​element-2.1Kyellow.png Patient Attributes Kyellow.png CEN/TC 251 prEN 17269
Treeblank.pngTreeblank.pngTreetree.png@classCode
cs0 … 1FPAT
Treeblank.pngTreeblank.pngTreetree.pnghl7:id
II1 … *RPatient Identifiers: Primary Patient Identifier (Regional/National Health Id), Secondary Patient Identifier (Social/Insurance Number)(HL7-IPS)
 
Target.png
hl7ips-data​element-202Kyellow.png Healthcare related Identifiers Kyellow.png CEN/TC 251 prEN 17269
hl7ips-data​element-7Kyellow.png Insurance identifier Kyellow.png CEN/TC 251 prEN 17269
Treeblank.pngTreeblank.pngTreetree.pnghl7:addr
AD.IPS1 … *RThe patient address.(HL7-IPS)
 
Target.png
hl7ips-data​element-162Kyellow.png Address Kyellow.png 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)
Treeblank.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.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.pngTreetree.pnghl7:streetAddressLine
ADXP0 … *CSubject's or Organization's Street Address Line(HL7-IPS)
 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.pngTreetree.pnghl7:city
ADXP0 … 1CSubject's or Organization's City(HL7-IPS)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:postalCode
ADXP0 … 1CSubject's or Organization's Postal Code(HL7-IPS)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:state
ADXP0 … 1CSubject's or Organization's State or Province(HL7-IPS)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:country
ADXP0 … 1CSubject's Country.(HL7-IPS)
 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.pngTreetree.pnghl7:telecom
TEL1 … *RPatient’s telecom information : e.g. telephone number, e-mail address. (HL7-IPS)
 
Target.png
hl7ips-data​element-100Kyellow.png Telecoms Kyellow.png CEN/TC 251 prEN 17269
Treeblank.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.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.pngTreeblank.pngTreetree.pnghl7:patient
1 … 1M(HL7-IPS)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.png@classCode
cs0 … 1FPSN
Treeblank.pngTreeblank.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.pngTreeblank.pngTreetree.pnghl7:name
PN1 … *MPatient Name(HL7-IPS)
 
Target.png
hl7ips-data​element-3Kyellow.png Patient's name Kyellow.png CEN/TC 251 prEN 17269
 ConstraintThe Alphabetic representation of the name SHALL be always provided
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:family
1 … *RPatient's Family Name/Surname(HL7-IPS)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:given
1 … *RPatient's Given Name(HL7-IPS)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:administrative​Gender​Code
CE.IPS1 … 1RPatient's Gender(HL7-IPS)
 
Target.png
hl7ips-data​element-4Kyellow.png Administrative gender Kyellow.png CEN/TC 251 prEN 17269
Treeblank.pngTreeblank.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 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>
Treeblank.pngTreeblank.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.(HL7-IPS)
 
Target.png
hl7ips-data​element-5Kyellow.png Date of birth Kyellow.png CEN/TC 251 prEN 17269
Treeblank.pngTreeblank.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.

(HL7-IPS)
Treeblank.pngTreeblank.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.pngTreeblank.pngTreetree.pnghl7:code
CD.IPS0 … 1RThe relationship between the patient and the guardian or other contact may be recorded in the element. (HL7-IPS)
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.19563 PersonalRelationshipRoleType (DYNAMIC)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:addr
AD.IPS1 … *R(HL7-IPS)
 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.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.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.pngTreeblank.pngTreetree.pnghl7:streetAddressLine
ADXP0 … *CSubject's or Organization's Street Address Line(HL7-IPS)
 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.pngTreeblank.pngTreetree.pnghl7:city
ADXP0 … 1CSubject's or Organization's City(HL7-IPS)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:postalCode
ADXP0 … 1CSubject's or Organization's Postal Code(HL7-IPS)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:state
ADXP0 … 1CSubject's or Organization's State or Province(HL7-IPS)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:country
ADXP0 … 1CSubject's Country.(HL7-IPS)
 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.pngTreeblank.pngTreetree.pnghl7:telecom
TEL1 … *RGuardian’s telecom information: e.g. telephone number; e-mail address. (HL7-IPS)
Treeblank.pngTreeblank.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.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.pngTreeblank.pngTreetree.pnghl7:guardian​Person
1 … 1R(HL7-IPS)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:name
PN1 … *RPatient Guardian's Name(HL7-IPS)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:family
ENXP1 … *RPatient Guardian's Family Name/Surname(HL7-IPS)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:given
ENXP1 … *RPatient Guardian's Given Name(HL7-IPS)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:language​Communication
0 … *R(HL7-IPS)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:language​Code
CS1 … 1RPatient’s language(HL7-IPS)
 
Target.png
hl7ips-data​element-135Kyellow.png Patient’s preferred language Kyellow.png CEN/TC 251 prEN 17269
 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.4.642.3.21 All Languages (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) 
Included1 … *M from 2.16.840.1.113883.10.22.2.2 IPS CDA author (DYNAMIC)
Treetree.pnghl7:author
1 … *M(HL7-IPS)
Treeblank.pngTreetree.png@typeCode
cs0 … 1FAUT
Treeblank.pngTreetree.png@context​Control​Code
cs0 … 1FOP
 Example<author>
  <time value="201212290600+0100"/>  <assignedAuthor>
    <id root="2.16.840.1.113883.2.9.4.3.2" extension="RSSMRA00A01F205F" assigningAuthorityName="Ministero Economia e Finanze"/>    <addr use="WP">
      <streetAddressLine>Viale della Cristallina 3</streetAddressLine>      <city>Bologna</city>      <state>BO</state>      <postalCode>40121</postalCode>      <country>IT</country>    </addr>    <telecom use="WP" value="tel:+39-051-34343434"/>    <assignedPerson>
      <name>
        <given>Paolo</given>        <family>Rossi</family>      </name>    </assignedPerson>  </assignedAuthor>  <representedOrganization>
    <!-- template 'IPS CDA Organization' (dynamic) -->
  </representedOrganization></author>
Treeblank.pngTreetree.pnghl7:functionCode
CE.IPS0 … 1R(HL7-IPS)
Treeblank.pngTreetree.pnghl7:time
TS.IPS.TZ1 … 1RThe author/time element represents the start time of the author’s participation in the creation of the clinical document. (HL7-IPS)
 Example<time value="201212290600+0100"/>
Treeblank.pngTreetree.pnghl7:assignedAuthor
1 … 1R(HL7-IPS)
Treeblank.pngTreeblank.pngTreetree.png@classCode
cs0 … 1FASSIGNED
Treeblank.pngTreeblank.pngTreetree.pnghl7:id
II1 … *RAuthor Identifier(s)(HL7-IPS)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.png@nullFlavor
cs0 … 1 
Treeblank.pngTreeblank.pngTreetree.pnghl7:code
CE.IPS (extensible)0 … 1RA code, which identifies the profession/competence/specialty of the author when it is a person.(HL7-IPS)
 CONF
The value of @code should be drawn from value set 2.16.840.1.113883.11.22.53 IPS Healthcare Professional Roles (DYNAMIC)
 Example<code code="221" codeSystem="2.16.840.1.113883.2.9.6.2.7" codeSystemName="ISCO" displayName="Medical doctors"/>
Treeblank.pngTreeblank.pngTreetree.pnghl7:addr
AD.IPS1 … *R(HL7-IPS)
 Example<addr use="WP">
  <streetAddressLine>Viale della Cristallina 3</streetAddressLine>  <city>Bologna</city>  <state>BO</state>  <postalCode>40121</postalCode>  <country>IT</country></addr>
Treeblank.pngTreeblank.pngTreetree.pnghl7:telecom
TEL.IPS1 … *R(HL7-IPS)
Treeblank.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.pngTreetree.png@value
url0 … 1 
 Example<telecom use="WP" value="tel:+39-051-34343434"/>
 Example<telecom nullFlavor="NI"/>
Choice1 … 1Elements to choose from:
  • hl7:assigned​Person
  • hl7:assigned​Authoring​Device
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:assigned​Person
0 … 1C(HL7-IPS)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@classCode
cs0 … 1FPSN
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@determiner​Code
cs0 … 1FINSTANCE
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:name
PN1 … *RName of the person (e.g. the Healthcare Professional)  authoring this document(HL7-IPS)
 Example<name>
  <given>John</given>  <family>Español Smith</family></name>
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:family
1 … *R(HL7-IPS)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:given
1 … *R(HL7-IPS)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:assigned​Authoring​Device
0 … 1C(HL7-IPS)
 Example<assignedAuthoringDevice classCode="DEV" determinerCode="INSTANCE">
  <softwareName displayName="Turriano"/></assignedAuthoringDevice>
Included from 2.16.840.1.113883.10.22.9.2 IPS CDA Device (DYNAMIC)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@classCode
cs0 … 1FDEV
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@determiner​Code
cs0 … 1FINSTANCE
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:code
CE0 … 1(HL7-IPS)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:manufacturer​Model​Name
SC0 … 1(HL7-IPS)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:softwareName
SC0 … 1(HL7-IPS)
Treeblank.pngTreeblank.pngTreetree.pnghl7:represented​Organization
0 … 1R(HL7-IPS)
Included from 2.16.840.1.113883.10.22.9.1 IPS CDA Organization (DYNAMIC)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FORG
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.png@determiner​Code
cs1 … 1FINSTANCE
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:id
II1 … *R(HL7-IPS)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@nullFlavor
cs0 … 1 
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:name
ON1 … 1R(HL7-IPS)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@nullFlavor
cs0 … 1 
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:telecom
TEL1 … *R(HL7-IPS)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@use
set_cs1 … 1R
 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 … 1 
 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:addr
AD.IPS1 … 1R(HL7-IPS)
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(HL7-IPS)
 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(HL7-IPS)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:postalCode
ADXP0 … 1CSubject's or Organization's Postal Code(HL7-IPS)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:state
ADXP0 … 1CSubject's or Organization's State or Province(HL7-IPS)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:country
ADXP0 … 1CSubject's Country.(HL7-IPS)
 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.
Included1 … 1M from 2.16.840.1.113883.10.22.2.3 IPS CDA custodian (DYNAMIC)
Treetree.pnghl7:custodian
1 … 1M(HL7-IPS)
Treeblank.pngTreetree.png@typeCode
cs0 … 1FCST
 Example<custodian typeCode="CST">
  <assignedCustodian classCode="ASSIGNED">
    <representedCustodianOrganization classCode="ORG" determinerCode="INSTANCE">
      <!-- template 'IPS CDA Organization' (dynamic) -->
    </representedCustodianOrganization>  </assignedCustodian></custodian>
Treeblank.pngTreetree.pnghl7:assignedCustodian
1 … 1R(HL7-IPS)
Treeblank.pngTreeblank.pngTreetree.png@classCode
cs0 … 1FASSIGNED
Treeblank.pngTreeblank.pngTreetree.pnghl7:represented​Custodian​Organization
1 … 1R(HL7-IPS)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.png@classCode
cs0 … 1FORG
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.png@determiner​Code
cs0 … 1FINSTANCE
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:id
II1 … *R(HL7-IPS)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@nullFlavor
cs0 … 1 
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:name
ON1 … 1R(HL7-IPS)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@nullFlavor
cs0 … 1 
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:telecom
TEL1 … 1R(HL7-IPS)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@use
set_cs1 … 1R
 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 … 1 
 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:addr
AD.IPS1 … 1R(HL7-IPS)
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(HL7-IPS)
 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(HL7-IPS)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:postalCode
ADXP0 … 1CSubject's or Organization's Postal Code(HL7-IPS)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:state
ADXP0 … 1CSubject's or Organization's State or Province(HL7-IPS)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:country
ADXP0 … 1CSubject's Country.(HL7-IPS)
 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.
Included0 … 1R from 2.16.840.1.113883.10.22.2.4 IPS CDA legalAuthenticator (DYNAMIC)
Treetree.pnghl7:legalAuthenticator
0 … 1R(HL7-IPS)
 Example<legalAuthenticator>
  <time value="20111013150937-0800"/>  <signatureCode code="S"/>  <assignedEntity>
    <id extension="admin" root="2.16.17.710.780.1000.903.1.1.3.3"/>    <assignedPerson>
      <name>
        <given>John</given>        <family>Español Smith</family>      </name>    </assignedPerson>    <representedOrganization>
      <name>Healthcare Facility's name</name>      <addr>
        <country>NL</country>        <streetName>Duinweg</streetName>        <houseNumber>23</houseNumber>        <postalCode>7364 RX</postalCode>        <city>Amsterdam</city>      </addr>    </representedOrganization>  </assignedEntity></legalAuthenticator>
Treeblank.pngTreetree.pnghl7:time
TS.IPS.TZ1 … 1MTime of signing the document(HL7-IPS)
Treeblank.pngTreetree.pnghl7:signatureCode
CS0 … 1RSignature code(HL7-IPS)
Treeblank.pngTreeblank.pngTreetree.png@code
CONF0 … 1FS
Treeblank.pngTreetree.pnghl7:assignedEntity
0 … 1RThe entity that is responsible for the legal authentication of the CDA document(HL7-IPS)
Treeblank.pngTreeblank.pngTreetree.pnghl7:id
1 … *RUnique identification of legal authenticator(HL7-IPS)
Treeblank.pngTreeblank.pngTreetree.pnghl7:addr
AD.IPS1 … *R(HL7-IPS)
Treeblank.pngTreeblank.pngTreetree.pnghl7:telecom
TEL.IPS1 … *R(HL7-IPS)
Treeblank.pngTreeblank.pngTreetree.pnghl7:assigned​Person
1 … 1R(HL7-IPS)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.png@classCode
cs0 … 1FPSN
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.png@determiner​Code
cs0 … 1FINSTANCE
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:name
PN1 … *RName of the legal authenticator(HL7-IPS)
 Example<name>
  <given>John</given>  <family>Español Smith</family></name>
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:family
1 … *RHP Family Name/Surname(HL7-IPS)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:given
1 … *RHP Given Name(HL7-IPS)
Treeblank.pngTreeblank.pngTreetree.pnghl7:represented​Organization
1 … 1MOrganization the legal authenticator is acting for
Contains 2.16.840.1.113883.10.22.9.1 IPS CDA Organization (DYNAMIC)		(HL7-IPS)
Included0 … * from 2.16.840.1.113883.10.22.2.5 IPS Patient Contacts (DYNAMIC)
Treetree.pnghl7:participant
0 … *RPatient contacts or the Preferred Health Professional to contact in case of emergency.(HL7-IPS)
where [hl7:templateId/@root='2.16.840.1.113883.10.22.2.5']
 
Target.png
hl7ips-data​element-154Kyellow.png Patient’s Address Book Kyellow.png CEN/TC 251 prEN 17269
hl7ips-data​element-163Kyellow.png Preferred Healthcare providers Kyellow.png CEN/TC 251 prEN 17269
Treeblank.pngTreetree.png@typeCode
cs1 … 1FIND
 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>
Treeblank.pngTreetree.pnghl7:templateId
II1 … 1M(HL7-IPS)
Treeblank.pngTreeblank.pngTreetree.png@root
uid1 … 1F2.16.840.1.113883.10.22.2.5
Treeblank.pngTreetree.pnghl7:functionCode
0 … 1CThe  <functionCode> element may be used to indicate that this participant is the preferred Health Professional to contact in case of emergency.</functionCode>(HL7-IPS)
Treeblank.pngTreeblank.pngTreetree.png@code
CONF0 … 1FPCP
Treeblank.pngTreeblank.pngTreetree.png@codeSystem
0 … 1F2.16.840.1.113883.5.88 (Participation Function)
Treeblank.pngTreetree.pnghl7:associated​Entity
RThe <associatedEntity> element identifies the type of contact. </associatedEntity>(HL7-IPS)
Treeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1R
 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>
Treeblank.pngTreeblank.pngTreetree.pnghl7:code
CV.IPS0 … 1RThis element indicates the relationship between the patient and this participant.(HL7-IPS)
 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"/>
Treeblank.pngTreeblank.pngTreetree.pnghl7:addr
AD.IPS1 … *RPatient Contact's / Preferred HP's Address(HL7-IPS)
 Schematron assertrole error 
 test@nullFlavor or hl7:* 
 MessageIf 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)
Treeblank.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.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.pngTreetree.pnghl7:streetAddressLine
ADXP0 … *CSubject's or Organization's Street Address Line(HL7-IPS)
 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.pngTreetree.pnghl7:city
ADXP0 … 1CSubject's or Organization's City(HL7-IPS)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:postalCode
ADXP0 … 1CSubject's or Organization's Postal Code(HL7-IPS)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:state
ADXP0 … 1CSubject's or Organization's State or Province(HL7-IPS)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:country
ADXP0 … 1CSubject's Country.(HL7-IPS)
 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.pngTreetree.pnghl7:telecom
TEL1 … *RPatient Contact's / Preferred HP's/Legal Organization telephone or e-mail <telecom> element is required.</telecom>(HL7-IPS)
 
Target.png
hl7ips-data​element-169Kyellow.png Telecoms Kyellow.png CEN/TC 251 prEN 17269
hl7ips-data​element-174Kyellow.png Telecoms Kyellow.png CEN/TC 251 prEN 17269
Treeblank.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.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="WP" value="tel:+45 20 7025 6161"/><telecom use="HP" value="mailto:jsmith@myprovider.co.uk"/>
Choice1 … 2Elements to choose from:
  • hl7:associated​Person
  • hl7:scoping​Organization
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:associated​Person
0 … 1COr the associatedPerson, or the scopingOrganization, or both elements shall be provided(HL7-IPS)
 
Target.png
hl7ips-data​element-165Kyellow.png Healthcare Provider (person) Kyellow.png CEN/TC 251 prEN 17269
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:name
PN1 … *RPatient Contact's Name / Preferred HP's Name(HL7-IPS)
 
Target.png
hl7ips-data​element-121Kyellow.png Name Kyellow.png CEN/TC 251 prEN 17269
 Example<name>
  <given>John</given>  <family>Español Smith</family></name>
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:family
1 … *RPatient Contact's Family Name/Surname / Preferred HP's Family Name/Surname(HL7-IPS)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:given
1 … *RPatient Contact's Given Name / Preferred HP's Given Name(HL7-IPS)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:scoping​Organization
0 … 1COr the associatedPerson, or the scopingOrganization, or both elements shall be provided(HL7-IPS)
 
Target.png
hl7ips-data​element-166Kyellow.png Healthcare Provider (organisation) Kyellow.png CEN/TC 251 prEN 17269
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:name
ON1 … *ROrganization's Name(HL7-IPS)
 
Target.png
hl7ips-data​element-172Kyellow.png Organisation’s Name Kyellow.png CEN/TC 251 prEN 17269
Included1 … 1M from 2.16.840.1.113883.10.22.2.6 IPS CDA documentationOf (DYNAMIC)
Treetree.pnghl7:documentationOf
1 … 1MThe documentationOf relationship in an International Patient Summary contains the representation of providers who are wholly or partially responsible for the safety and well-being of a subject of care.(HL7-IPS)
Treeblank.pngTreetree.png@typeCode
cs0 … 1FDOC
 Example<documentationOf>
  <serviceEvent classCode="PCPR">
    <effectiveTime>
      <low nullFlavor="NI"/>      <high value="20110308"/>    </effectiveTime>    <performer typeCode="PRF">
      <!-- See example below -->
    </performer>  </serviceEvent></documentationOf>
Treeblank.pngTreetree.pnghl7:serviceEvent
1 … 1RThe main activity being described by a IPS is the provision of healthcare over a period of time. This is shown by setting the value of serviceEvent/@classCode to “PCPR” (care provision) and indicating the duration over which care was provided in serviceEvent/effectiveTime. Additional data from outside this duration may also be included if it is relevant to care provided during that time range (e.g., reviewed during the stated time range).

For example if the IPS is generated by a GP based on information recorded in his/her EHR-S, then the low value should represent the date when the treatment relationship between the patient and the GP started; and the high value the date of the latest care event.		(HL7-IPS)
Treeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FPCPR
Treeblank.pngTreeblank.pngTreetree.png@moodCode
cs1 … 1FEVN
Treeblank.pngTreeblank.pngTreetree.pnghl7:id
II0 … *R(HL7-IPS)
Treeblank.pngTreeblank.pngTreetree.pnghl7:effectiveTime
IVL_TS1 … 1R(HL7-IPS)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:low
TS1 … 1R(HL7-IPS)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:high
TS1 … 1R(HL7-IPS)
Treeblank.pngTreeblank.pngTreetree.pnghl7:performer
0 … *RIt represents the healthcare providers involved in the current or pertinent historical care of the patient. Preferably, the patient’s key healthcare providers would be listed, particularly their primary physician and any active consulting physicians, therapists, and counselors(HL7-IPS)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.png@typeCode
cs1 … 1R
 CONF
The value of @typeCode shall be drawn from value set 2.16.840.1.113883.1.11.19601 x_ServiceEventPerformer (DYNAMIC)
 Example<performer typeCode="PRF">
  <assignedEntity>
    <id assigningAuthorityName="MEF" displayable="false" extension="DVLMMG57R07F205G" root="2.16.840.1.113883.2.9.4.3.2"/>    <code code="221" codeSystem="2.16.840.1.113883.2.9.6.2.7" codeSystemName="ISCO" displayName="Medical doctors">
      <translation codeSystem="2.16.840.1.113883.2.9.5.1.111" code="MMG" displayName="Medico di Medicina Generale"/>    </code>    <addr nullFlavor="NI"/>    <telecom nullFlavor="NI"/>    <assignedPerson>
      <name>
        <family>DVALUNO</family>        <given>MMG</given>      </name>    </assignedPerson>    <representedOrganization>
      <id assigningAuthorityName="A.S.L. DELLA PROVINCIA DI LECCO" extension="030305" root="2.16.840.1.113883.2.9.4.1.1"/>      <name>A.S.L. DELLA PROVINCIA DI LECCO</name>      <telecom nullFlavor="NI"/>      <addr>
        <state>LECCO</state>        <city>LECCO</city>        <country>IT</country>        <postalCode>23900</postalCode>        <streetAddressLine>CORSO CARLO ALBERTO,120</streetAddressLine>      </addr>    </representedOrganization>  </assignedEntity></performer>
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:functionCode
CE.IPS0 … 1R(HL7-IPS)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:time
IVL_TS.IPS.TZ0 … 1R(HL7-IPS)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:assignedEntity
1 … 1M(HL7-IPS)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:id
II1 … *RHealthcare provider ID number(HL7-IPS)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:code
CE.IPS (extensible)0 … 1RIt describes the professional role of the healthcare provider involved in the current or pertinent historical care of the patient.(HL7-IPS)
 CONF
The value of @code should be drawn from value set 2.16.840.1.113883.11.22.53 IPS Healthcare Professional Roles (DYNAMIC)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:addr
AD.IPS1 … *R(HL7-IPS)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:telecom
TEL.IPS1 … *R(HL7-IPS)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:assigned​Person
0 … 1(HL7-IPS)
Included from 2.16.840.1.113883.10.22.9.3 IPS CDA Person (DYNAMIC)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@classCode
cs0 … 1FPSN
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@determiner​Code
cs0 … 1FINSTANCE
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:name
PN1 … *R(HL7-IPS)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:represented​Organization
0 … 1Contains 2.16.840.1.113883.10.22.9.1 IPS CDA Organization (DYNAMIC)(HL7-IPS)
Included0 … 2R from 2.16.840.1.113883.10.22.2.7 IPS CDA relatedDocument (DYNAMIC)
 ConstraintA conformant CDA document can have:
  • a single relatedDocument with typeCode "APND"; OR
  • a single relatedDocument with typeCode "RPLC"; OR
  • a single relatedDocument with typeCode "XFRM";  OR
  • a combination of two relatedDocuments with typeCodes "XFRM" and "RPLC"; OR
  • a combination of two relatedDocuments with typeCodes "XFRM" and "APND". 
No other combinations are allowed. 
Treetree.pnghl7:relatedDocument
0 … 2R(HL7-IPS)
Treeblank.pngTreetree.png@typeCode
cs1 … 1R
 CONF
The value of @typeCode shall be drawn from value set 2.16.840.1.113883.1.11.11610 x_ActRelationshipDocument (DYNAMIC)
Treeblank.pngTreetree.pnghl7:parentDocument
1 … 1R(HL7-IPS)
Treeblank.pngTreeblank.pngTreetree.png@classCode
cs0 … 1FDOCCLIN
Treeblank.pngTreeblank.pngTreetree.png@moodCode
cs0 … 1FEVN
Treeblank.pngTreeblank.pngTreetree.pnghl7:id
II1 … *R(HL7-IPS)
Treeblank.pngTreeblank.pngTreetree.pnghl7:code
CD.IPS0 … 1R(HL7-IPS)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.png@codeSystem
CONF0 … 1F2.16.840.1.113883.6.1 (LOINC)
Treeblank.pngTreeblank.pngTreetree.pnghl7:text
ED0 … 1R(HL7-IPS)
Treeblank.pngTreeblank.pngTreetree.pnghl7:setId
II0 … 1R(HL7-IPS)
Treeblank.pngTreeblank.pngTreetree.pnghl7:versionNumber
INT0 … 1R(HL7-IPS)
Treetree.pnghl7:component
1 … 1M(HL7-IPS)
Treeblank.pngTreetree.pnghl7:structuredBody
1 … 1MNote: the proposed order of the sections hereafter indicated is not mandatory(HL7-IPS)
Treeblank.pngTreeblank.pngTreetree.png@classCode
cs0 … 1FDOCBODY
Treeblank.pngTreeblank.pngTreetree.pnghl7:component
1 … 1MContains 2.16.840.1.113883.10.22.3.1 IPS Medication Summary Section (DYNAMIC)(HL7-IPS)
Treeblank.pngTreeblank.pngTreetree.pnghl7:component
1 … 1MContains 2.16.840.1.113883.10.22.3.2 IPS Allergies and Intolerances Section (DYNAMIC)(HL7-IPS)
Treeblank.pngTreeblank.pngTreetree.pnghl7:component
1 … 1MContains 2.16.840.1.113883.10.22.3.3 IPS Problems Section (DYNAMIC)(HL7-IPS)
Treeblank.pngTreeblank.pngTreetree.pnghl7:component
0 … 1RContains 2.16.840.1.113883.10.22.3.4 IPS History of Procedures Section (DYNAMIC)(HL7-IPS)
Treeblank.pngTreeblank.pngTreetree.pnghl7:component
0 … 1RContains 2.16.840.1.113883.10.22.3.5 IPS Immunizations Section (DYNAMIC)(HL7-IPS)
Treeblank.pngTreeblank.pngTreetree.pnghl7:component
0 … 1RContains 2.16.840.1.113883.10.22.3.6 IPS Medical Devices Section (DYNAMIC)(HL7-IPS)
Treeblank.pngTreeblank.pngTreetree.pnghl7:component
0 … 1RContains 2.16.840.1.113883.10.22.3.14 IPS Results Section (DYNAMIC)(HL7-IPS)
Treeblank.pngTreeblank.pngTreetree.pnghl7:component
0 … 1RContains 1.3.6.1.4.1.19376.1.5.3.1.1.5.3.2 IHE Coded Vital Signs Section (DYNAMIC)(HL7-IPS)
Treeblank.pngTreeblank.pngTreetree.pnghl7:component
0 … 1Contains 2.16.840.1.113883.10.22.3.7 IPS History of Past Illness Section (DYNAMIC)(HL7-IPS)
Treeblank.pngTreeblank.pngTreetree.pnghl7:component
0 … 1Contains 2.16.840.1.113883.10.22.3.8 IPS Functional Status Section (DYNAMIC)(HL7-IPS)
Treeblank.pngTreeblank.pngTreetree.pnghl7:component
0 … 1Contains 2.16.840.1.113883.10.22.3.9 IPS Plan of Care Section (DYNAMIC)(HL7-IPS)
Treeblank.pngTreeblank.pngTreetree.pnghl7:component
0 … 1Contains 2.16.840.1.113883.10.22.3.10 IPS Social History Section (DYNAMIC)(HL7-IPS)
Treeblank.pngTreeblank.pngTreetree.pnghl7:component
0 … 1Contains 2.16.840.1.113883.10.22.3.11 IPS History of Pregnancy Section (DYNAMIC)(HL7-IPS)
Treeblank.pngTreeblank.pngTreetree.pnghl7:component
0 … 1Contains 2.16.840.1.113883.10.22.3.12 IPS Advance Directives Section (DYNAMIC)(HL7-IPS)
Treeblank.pngTreeblank.pngTreetree.pnghl7:component
0 … 1Contains 2.16.840.1.113883.10.22.15 IPS Alerts Section (DYNAMIC)(HL7-IPS)
Treeblank.pngTreeblank.pngTreetree.pnghl7:component
0 … 1Contains 2.16.840.1.113883.10.22.16 IPS Patient Story Section (DYNAMIC)(HL7-IPS)
Retrieved from "http://wiki.international-patient-summary.net/index.php?title=2.16.840.1.113883.10.22.1.2/static-2024-08-02T130239&oldid=10825"