Back To Index  <<  Back To Templates

pending Template  IPS CDA documentationOf

Id 2.16.840.1.113883.10.22.2.6 Effective Date 2017‑04‑12
Status pending Under pre-publication review Version Label STU1
Name IPSdocumentationOfPCPR Display Name IPS CDA documentationOf
Description
The 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.

The 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.
Classification CDA Header Level Template
Open/Closed Open (other than defined elements are allowed)
Used by / Uses
Used by 1 transaction and 2 templates, Uses 2 templates
Used by as Name Version
hl7ips-transaction-2 Transaction draft IPS Created 2017‑04‑07 11:10:54
2.16.840.1.113883.10.22.1.1 Include draft International Patient Summary 2020‑05‑08 12:30:59
2.16.840.1.113883.10.22.1.1 Include pending International Patient Summary (STU1) 2017‑04‑11
Uses as Name Version
2.16.840.1.113883.10.22.9.3 Containment pending IPS CDA Person (STU1) DYNAMIC
2.16.840.1.113883.10.22.9.1 Containment pending IPS CDA Organization (STU1) DYNAMIC
Relationship Adaptation: template 2.16.840.1.113883.10.12.110 CDA documentationOf (2005‑09‑07)
ref
ad1bbr-
Example
Example
<documentationOf typeCode="DOC">
  <serviceEvent classCode="PCPR" moodCode="EVN">
    <id root="1.2.3.999" extension="__example only__"/>    <effectiveTime>
      <low nullFlavor="UNK"/>      <high value="20170613124706"/>    </effectiveTime>    <performer typeCode="PRF">
      <assignedEntity>
        <id root="1.2.3.999" extension="__example only__"/>        <code code="22" displayName="Health professionals" codeSystem="2.16.840.1.113883.2.9.6.2.7"/>        <addr nullFlavor="NI"/>        <telecom nullFlavor="NI"/>        <assignedPerson>
          <!-- template 'IPS CDA Person' (dynamic) -->
        </assignedPerson>        <representedOrganization>
          <!-- template 'IPS CDA Organization' (dynamic) -->
        </representedOrganization>      </assignedEntity>    </performer>  </serviceEvent></documentationOf>
Item DT Card Conf Description Label
hl7:documentationOf
 		0 … * R The 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. (IPSdotsCPR)
@typeCode
 		cs 0 … 1 F DOC
  Example <documentationOf>
  <serviceEvent classCode="PCPR">
    <effectiveTime>
      <low nullFlavor="NI"/>      <high value="20110308"/>    </effectiveTime>    <performer typeCode="PRF">
      <!-- See example below -->
    </performer>  </serviceEvent></documentationOf>
hl7:serviceEvent
 		1 … 1 R The 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. 		(IPSdotsCPR)
@classCode
 		cs 1 … 1 F PCPR
@moodCode
 		cs 1 … 1 F EVN
hl7:id
 		II 0 … * R (IPSdotsCPR)
hl7:effectiveTime
 		IVL_TS 1 … 1 R (IPSdotsCPR)
hl7:low
 		TS 1 … 1 R (IPSdotsCPR)
hl7:high
 		TS 1 … 1 R (IPSdotsCPR)
hl7:performer
 		0 … * R It 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 (IPSdotsCPR)
@typeCode
 		cs 1 … 1 R
  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>
hl7:functionCode
 		CE.IPS 0 … 1 R (IPSdotsCPR)
hl7:time
 		IVL_TS.IPS.TZ 0 … 1 R (IPSdotsCPR)
hl7:assignedEntity
 		1 … 1 M (IPSdotsCPR)
hl7:id
 		II 1 … * R Healthcare provider ID number (IPSdotsCPR)
hl7:code
 		CE.IPS (extensible) 0 … 1 R It describes the professional role of the healthcare provider involved in the current or pertinent historical care of the patient. (IPSdotsCPR)
  CONF
The value of @code should be drawn from value set 2.16.840.1.113883.11.22.53 IPS Healthcare Professional Roles (DYNAMIC)
hl7:addr
 		AD.IPS 1 … * R (IPSdotsCPR)
hl7:telecom
 		TEL.IPS 1 … * R (IPSdotsCPR)
hl7:assignedPerson
 		0 … 1 Contains 2.16.840.1.113883.10.22.9.3 IPS CDA Person (DYNAMIC) (IPSdotsCPR)
hl7:representedOrganization
 		0 … 1 Contains 2.16.840.1.113883.10.22.9.1 IPS CDA Organization (DYNAMIC) (IPSdotsCPR)