Id2.16.840.1.113883.3.1937.777.11.10.101Effective Date2013‑12‑20
Statusdraft DraftVersion Label
NameepSOSCDAContactOrPreferredHPDisplay NameepSOS CDA Contact/Preferred HP/Legal Organization
Description

The guardians of a patient shall be recorded in the <guardian> element beneath the /ClinicalDocument/recordTarget/patientRole/patient XML - <patient> element. Other patient contacts such as the preferred health provider are described using the /ClinicalDocument/participant structure. The <associatedEntity> element defines the type of contact. The classCode attribute shall be present, and contains a value from the set AGNT, CAREGIVER, ECON, NOK, or PRS to identify contacts that are agents of the patient, care givers, emergency contacts, next of kin, or other relations respectively.

The relationship between the patient and the guardian or other contact should be recorded in the <code> element. The code attribute is required and comes from the HL7 PersonalRelationshipRoleType vocabulary (epSOSPersonalRelationship value set).

The address of the guardian or other contact should be present, and shall be represented as any other address would be in CDA.

The phone number of the guardian or other contact should be present, and shall be represented as 480 any other phone number would be in CDA.

The name of the guardian or other contact shall be present, and shall be represented as any other name would be in CDA.

Healthcare Service Identification

The Healthcare Service Identification information is represented in structures under the /ClinicalDocument/author XML element

ClassificationCDA Header Level Template
Open/ClosedOpen (other than defined elements are allowed)
Associated with
Associated with 16 concepts
IdNameData Set
epsos-dataelement-40draft Email draft epSOS Data Set
epsos-dataelement-35draft Role of that person draft epSOS Data Set
epsos-dataelement-50draft Email draft epSOS Data Set
epsos-dataelement-31draft Legal Organization to contact draft epSOS Data Set
epsos-dataelement-43draft Email draft epSOS Data Set
epsos-dataelement-37draft Given Name draft epSOS Data Set
epsos-dataelement-34draft Contact Person/legal guardian draft epSOS Data Set
epsos-dataelement-38draft Family Name/Surname draft epSOS Data Set
epsos-dataelement-47draft Given Name draft epSOS Data Set
epsos-dataelement-41draft Telephone No draft epSOS Data Set
epsos-dataelement-46draft Full Name draft epSOS Data Set
epsos-dataelement-48draft Family Name/Surname draft epSOS Data Set
epsos-dataelement-39draft Telephone No draft epSOS Data Set
epsos-dataelement-49draft Telephone No draft epSOS Data Set
epsos-dataelement-30draft Preferred HP to contact draft epSOS Data Set
epsos-dataelement-33draft Organization Name draft epSOS Data Set
Used by / Uses
Used by 6 transactions and 19 templates, Uses 0 templates
Used by as NameVersion
2.16.840.1.113883.3.1937.777.78.4.8Transactiondraft Patient summary2024‑01‑18
2.16.840.1.113883.3.1937.777.11.4.12Transactiondraft Return PS of country A2012‑05‑02
2.16.840.1.113883.3.1937.777.11.4.23Transactiondraft Return MRO2013‑11‑02
2.16.840.1.113883.3.1937.777.11.4.29Transactiondraft Return PS (PDF embedded) of country A2017‑11‑20 18:28:16
2.16.840.1.113883.3.1937.777.78.4.10Transactiondraft Patient Summary (PDF embedded)2024‑01‑18
2.16.840.1.113883.3.1937.777.11.4.21Transactiondraft Send HCER to country A2013‑11‑02
1.2.203.24341.11.10.1.1Includedraft CZ-Patient Summary2019‑11‑08 19:31:50
1.3.6.1.4.1.12559.11.10.1.3.1.1.3Includedraft epSOS-Patient Summary2013‑12‑20
1.3.6.1.4.1.12559.11.10.1.3.1.1.3Includeretired epSOS-Patient Summary2018‑11‑14 10:53:50
1.3.6.1.4.1.12559.11.10.1.3.1.1.3Includeretired eHDSI Patient Summary2020‑04‑14 13:03:47
1.3.6.1.4.1.12559.11.10.1.3.1.1.3Includeretired eHDSI Patient Summary2020‑09‑02 10:19:44
1.3.6.1.4.1.12559.11.10.1.3.1.1.3Includeretired eHDSI Patient Summary2022‑09‑12 13:44:19
1.3.6.1.4.1.12559.11.10.1.3.1.1.3Includeactive eHDSI Patient Summary2024‑04‑19 10:03:32
1.3.6.1.4.1.12559.11.10.1.3.1.1.4Includedraft epSOS-Health Care Encounter Report2013‑12‑20
1.3.6.1.4.1.12559.11.10.1.3.1.1.4Includeretired epSOS-Health Care Encounter Report2018‑11‑14 09:02:41
1.3.6.1.4.1.12559.11.10.1.3.1.1.5Includedraft epSOS-Medication Related Overview2013‑12‑20
1.3.6.1.4.1.12559.11.10.1.3.1.1.5Includeretired epSOS-Medication Related Overview2018‑11‑14 09:03:13
1.3.6.1.4.1.12559.11.10.1.3.1.1.7Includedraft eHDSI-Patient Summary PDF embedded2017‑03‑11 18:41:31
1.3.6.1.4.1.12559.11.10.1.3.1.1.7Includeretired eHDSI-Patient Summary PDF embedded2018‑11‑14 09:01:49
1.3.6.1.4.1.12559.11.10.1.3.1.1.7Includeretired eHDSI Patient Summary PDF embedded2020‑04‑14 13:05:42
1.3.6.1.4.1.12559.11.10.1.3.1.1.7Includeretired eHDSI Patient Summary PDF embedded2020‑09‑09 12:49:26
1.3.6.1.4.1.12559.11.10.1.3.1.1.7Includeretired eHDSI Patient Summary PDF embedded2022‑09‑12 13:45:01
1.3.6.1.4.1.12559.11.10.1.3.1.1.7Includeactive eHDSI Patient Summary PDF embedded2024‑04‑19 10:04:07
2.16.840.1.113883.3.1937.777.78.10.4Includeactive UNICOM Patient Summary PDF embedded (v0.1)2024‑01‑18 11:56:32
2.16.840.1.113883.3.1937.777.78.10.5Includeactive UNICOM Patient Summary (v0.1)2024‑01‑18 11:57:06
RelationshipSpecialization: template 2.16.840.1.113883.10.12.108 CDA participant (DYNAMIC)
ref
ad1bbr-

Adaptation: template 1.3.6.1.4.1.19376.1.5.3.1.2.4 (DYNAMIC)
Example
Contact person
<participant typeCode="IND">
  <templateId root="1.3.6.1.4.1.19376.1.5.3.1.2.4"/>  <time value="20070213"/>  <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>
Example
Preferred HP
<participant typeCode="IND">
  <templateId root="1.3.6.1.4.1.19376.1.5.3.1.2.4"/>  <functionCode code="PCP" codeSystem="2.16.840.1.113883.5.88"/>  <associatedEntity classCode="PRS">
    <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>
</participant>
ItemDTCardConfDescriptionLabel
hl7:participant
RContact person / Preferred Health Professional to contact about patient.epSOdotsedHP
where [hl7:templateId/@root='1.3.6.1.4.1.19376.1.5.3.1.2.4']
 
target
epsos-dataelement-31draft Legal Organization to contact draft epSOS Data Set
epsos-dataelement-34draft Contact Person/legal guardian draft epSOS Data Set
epsos-dataelement-30draft Preferred HP to contact draft epSOS Data Set
@typeCode
cs1 … 1FINDR1.8.5
 Participant typeCode
hl7:templateId
1 … 1MepSOdotsedHP
@root
uid1 … 1F1.3.6.1.4.1.19376.1.5.3.1.2.4
hl7:functionCode
0 … 1CepSOdotsedHP
 ConstraintThe element is mandatory when this participant is the preferred HP
@code
CONF0 … 1FPCP
@codeSystem
0 … 1F2.16.840.1.113883.5.88
hl7:time
IVL_TS.EPSOS.TZ.OPT0 … 1RThe epSOdotsedHP
hl7:associatedEntity
RThe element identifies the type of contact. The classCode attribute shall be present, and contains a value from the epSOSRoleClass value set when used for the patient contacts; ‘PRS’ when used for “Preferred HP / Legal Organization”.epSOdotsedHP
@classCode
cs1 … 1RR1.8.6
 CONF
The value of @classCode shall be drawn from value set 1.3.6.1.4.1.12559.11.10.1.3.1.42.39 epSOSRoleClass (DYNAMIC)
or
@classCode shall be "PRS"
hl7:code
CV.EPSOS0 … 1RThe relationship between the patient and the guardian or other contact should be recorded in the element. The code attribute is required and comes from the HL7 PersonalRelationshipRoleType vocabulary with codeSystem (2.16.840.1.113883.5.111). The codeSystem attribute is required. The relationship between the patient and his preferred HP comes from the the full RoleCode (2.16.840.1.113883.5.111) codeSystemR1.8.6
 
target
epsos-dataelement-35draft Role of that person draft epSOS Data Set
 CONF
The value of @code shall be drawn from value set 1.3.6.1.4.1.12559.11.10.1.3.1.42.38 epSOSPersonalRelationship (DYNAMIC)
hl7:addr
AD.EPSOS1 … 1RPatient Contact's / Preferred HP's AddressR1.8.3 / R1.9.2
@nullFlavor
cs0 … 1FNI
 Schematron assertrolered error 
 test@nullFlavor or hl7:* 
 MessageIf addr is not nullflavored at least one sub element has to be provided 
hl7:streetAddressLine
0 … *RPatient Contact's Street/Number of Street / Preferred HP's Street/Number of StreetR1.8.3.1 / R1.8.3.2 / R1.9.2.1 / R1.9.2.2
hl7:city
0 … 1RPatient Contact's City / Preferred HP's CityR1.8.2.3 / R1.9.2.3
hl7:postalCode
0 … 1RPatient Contact's Postal Code / Preferred HP's Postal CodeR1.8.2.4 / R1.9.2.4
hl7:state
0 … 1RPatient Contact's State or Province / Preferred HP's State or ProvinceR1.8.2.5 / R1.9.2.5
hl7:country
0 … 1RPatient Contact's Country / Preferred HP's Country. When used addr.country it is always bound to the epSOSCountry value setR1.8.2.6 / R1.9.2.6
hl7:telecom
TEL1 … *RPatient Contact's / Preferred HP's/Legal Organization telephone or e-mail element is required. If there is no information, the nullFlavor attribute shall have a value of 'UNK' 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 presentR1.8.4.1 / R1.8.4.2 / R1.9.3.1 / R1.9.3.2
 
target
epsos-dataelement-40draft Email draft epSOS Data Set
epsos-dataelement-50draft Email draft epSOS Data Set
epsos-dataelement-43draft Email draft epSOS Data Set
epsos-dataelement-41draft Telephone No draft epSOS Data Set
epsos-dataelement-39draft Telephone No draft epSOS Data Set
epsos-dataelement-49draft Telephone No draft epSOS Data Set
@use
set_cs0 … 1 
 CONF
The value of @use shall be drawn from value set 1.3.6.1.4.1.12559.11.10.1.3.1.42.40 epSOSTelecomAddress (DYNAMIC)
@nullFlavor
cs0 … 1FNI
 Example<telecom use="WP" value="tel:+45 20 7025 6161"/><telecom use="HP" value="mailto:jsmith@myprovider.co.uk"/>
Choice1 … 1Elements to choose from:
  • hl7:associatedPerson
  • hl7:scopingOrganization
hl7:associatedPerson
RepSOdotsedHP
hl7:name
PN1 … 1RPatient Contact's Name / Preferred HP's NameIHE PCC / R1.9.1
 
target
epsos-dataelement-46draft Full Name draft epSOS Data Set
 Example<name>
  <given>John</given>  <family>Español Smith</family></name>
Choice2 … *Elements to choose from:
  • hl7:family
  • hl7:given
hl7:family
1 … *RPatient Contact's Family Name/Surname / Preferred HP's Family Name/SurnameR1.8.1 / R1.9.1.1
 
target
epsos-dataelement-38draft Family Name/Surname draft epSOS Data Set
epsos-dataelement-48draft Family Name/Surname draft epSOS Data Set
hl7:given
1 … *RPatient Contact's Given Name / Preferred HP's Given NameR1.8.2 / R1.9.1.2
 
target
epsos-dataelement-37draft Given Name draft epSOS Data Set
epsos-dataelement-47draft Given Name draft epSOS Data Set
hl7:scopingOrganization
RepSOdotsedHP
hl7:name
ON1 … 1ROrganization's NameR1.9.1
 
target
epsos-dataelement-33draft Organization Name draft epSOS Data Set