Template

Show index

Template eHDSI RecordTarget 2020‑10‑02 14:05:45

Id2.16.840.1.113883.3.1937.777.11.10.100Effective Date2020‑10‑02 14:05:45
Statusretired RetiredVersion Label
NameeHDSIRecordTargetDisplay NameeHDSI RecordTarget
ClassificationCDA Header Level Template
Open/ClosedOpen (other than defined elements are allowed)
Associated with
Associated with 37 concepts
IdNameData Set
ehdsi-dataelement-157draft Street draft eHDSI Data Set
ehdsi-dataelement-156draft Number of Street draft eHDSI Data Set
ehdsi-dataelement-155draft City draft eHDSI Data Set
ehdsi-dataelement-154draft Postal Code draft eHDSI Data Set
ehdsi-dataelement-153draft State or Province draft eHDSI Data Set
ehdsi-dataelement-152draft Country draft eHDSI Data Set
ehdsi-dataelement-150draft Telephone No draft eHDSI Data Set
ehdsi-dataelement-159draft Gender Code draft eHDSI Data Set
ehdsi-dataelement-161draft Date of Birth draft eHDSI Data Set
ehdsi-dataelement-163draft Family Name/Surname draft eHDSI Data Set
ehdsi-dataelement-164draft Given Name draft eHDSI Data Set
ehdsi-dataelement-170draft National Healthcare Patient identifier (Country of Affiliation) draft eHDSI Data Set
ehdsi-dataelement-250draft Regional/National Health Identifier draft eHDSI Data Set
ehdsi-dataelement-246draft Family Name/Surname draft eHDSI Data Set
ehdsi-dataelement-247draft Given Name draft eHDSI Data Set
ehdsi-dataelement-244draft Gender draft eHDSI Data Set
ehdsi-dataelement-242draft Date of Birth draft eHDSI Data Set
ehdsi-dataelement-316draft Regional/National Health Identifier draft eHDSI Data Set
ehdsi-dataelement-310draft Given Name draft eHDSI Data Set
ehdsi-dataelement-309draft Family Name/Surname draft eHDSI Data Set
ehdsi-dataelement-307draft Gender draft eHDSI Data Set
ehdsi-dataelement-313draft Social/Insurance Number draft eHDSI Data Set
ehdsi-dataelement-239draft Social/Insurance Number draft eHDSI Data Set
ehdsi-dataelement-167draft Insurance Number draft eHDSI Data Set
ehdsi-dataelement-148draft E-mail draft eHDSI Data Set
ehdsi-dataelement-353draft Insurance Number draft eHDSI Data Set
ehdsi-dataelement-349draft Family Name/Surname draft eHDSI Data Set
ehdsi-dataelement-350draft Given Name draft eHDSI Data Set
ehdsi-dataelement-346draft Date of Birth draft eHDSI Data Set
ehdsi-dataelement-344draft Gender Code draft eHDSI Data Set
ehdsi-dataelement-342draft Street draft eHDSI Data Set
ehdsi-dataelement-341draft Number of Street draft eHDSI Data Set
ehdsi-dataelement-340draft City draft eHDSI Data Set
ehdsi-dataelement-339draft Postal Code draft eHDSI Data Set
ehdsi-dataelement-338draft State or Province draft eHDSI Data Set
ehdsi-dataelement-337draft Country draft eHDSI Data Set
ehdsi-dataelement-356draft Regional/National Health ID (Country of Affiliation) draft eHDSI Data Set
RelationshipVersion: template 2.16.840.1.113883.3.1937.777.11.10.100 eHDSI RecordTarget (2020‑04‑16 10:58:00)
Version: template 2.16.840.1.113883.3.1937.777.11.10.100 epSOS CDA recordTarget (2018‑11‑14 10:54:53)
Specialization: template 2.16.840.1.113883.10.12.101 CDA recordTarget (2005‑09‑07)
ref
ad1bbr-
ItemDTCardConfDescriptionLabel
hl7:recordTarget
1 … *ReHDSdotsrget
@typeCode
cs0 … 1FRCT
@contextControlCode
cs0 … 1FOP
hl7:patientRole
1 … 1MeHDSdotsrget
@classCode
cs0 … 1FPAT
hl7:id
II.EPSOS1 … *RPatient Identifiers: Primary Patient Identifier (Regional/National Health Id), Secondary Patient Identifier (Social/Insurance Number)R1.4 / R1.4.1 / R1.4.2
 
target
ehdsi-dataelement-170draft National Healthcare Patient identifier (Country of Affiliation) draft eHDSI Data Set
ehdsi-dataelement-250draft Regional/National Health Identifier draft eHDSI Data Set
ehdsi-dataelement-316draft Regional/National Health Identifier draft eHDSI Data Set
ehdsi-dataelement-313draft Social/Insurance Number draft eHDSI Data Set
ehdsi-dataelement-239draft Social/Insurance Number draft eHDSI Data Set
ehdsi-dataelement-167draft Insurance Number draft eHDSI Data Set
ehdsi-dataelement-353draft Insurance Number draft eHDSI Data Set
ehdsi-dataelement-356draft Regional/National Health ID (Country of Affiliation) draft eHDSI Data Set
hl7:addr
AD.EPSOS1 … 1RThe patient address element is required. 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.R1.5
@nullFlavor
cs0 … 1FNI
hl7:streetAddressLine
0 … *RPatient's Number of Street/Patient's Number of StreetR1.5.1 / R1.5.2
 
target
ehdsi-dataelement-157draft Street draft eHDSI Data Set
ehdsi-dataelement-156draft Number of Street draft eHDSI Data Set
ehdsi-dataelement-342draft Street draft eHDSI Data Set
ehdsi-dataelement-341draft Number of Street draft eHDSI Data Set
hl7:city
0 … 1RPatient's CityR1.5.3
 
target
ehdsi-dataelement-155draft City draft eHDSI Data Set
ehdsi-dataelement-340draft City draft eHDSI Data Set
hl7:postalCode
0 … 1RPatient's Postal CodeR1.5.4
 
target
ehdsi-dataelement-154draft Postal Code draft eHDSI Data Set
ehdsi-dataelement-339draft Postal Code draft eHDSI Data Set
hl7:state
0 … 1RPatient's State or ProvinceR1.5.5
 
target
ehdsi-dataelement-153draft State or Province draft eHDSI Data Set
ehdsi-dataelement-338draft State or Province draft eHDSI Data Set
hl7:country
0 … 1RPatient's Country. When used addr.country it is always bound to the eHDSICountry value setR1.5.6
 
target
ehdsi-dataelement-152draft Country draft eHDSI Data Set
ehdsi-dataelement-337draft Country draft eHDSI Data Set
 ConstraintThe content of this element SHALL be selected from ValueSet eHDSICountry urn:oid:1.3.6.1.4.1.12559.11.10.1.3.1.42.4
hl7:telecom
TEL1 … *RPatient’s telephone number / Patient e-mail address. The patient telephone or e-mail element is required. If 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 Optionalities and Cardinalities of the following two items shall be interpreted according to this rule: e.g. is not expected to have two nullFlavored telecom elements.R1.6.1 / R1.6.2
 
target
ehdsi-dataelement-150draft Telephone No draft eHDSI Data Set
ehdsi-dataelement-148draft E-mail draft eHDSI 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 eHDSITelecomAddress (DYNAMIC)
@nullFlavor
cs0 … 1FNI
hl7:patient
1 … 1MeHDSdotsrget
@classCode
cs0 … 1FPSN
@determinerCode
cs0 … 1FINSTANCE
hl7:name
PN1 … *MPatient NameR1.1
hl7:family
1 … *MPatient's Family Name/SurnameR1.1.1
 
target
ehdsi-dataelement-163draft Family Name/Surname draft eHDSI Data Set
ehdsi-dataelement-246draft Family Name/Surname draft eHDSI Data Set
ehdsi-dataelement-309draft Family Name/Surname draft eHDSI Data Set
ehdsi-dataelement-349draft Family Name/Surname draft eHDSI Data Set
hl7:prefix
0 … *RPatient's PrefixR1.1.2
 ConstraintIf the attribute qualifier is used for this element it should be derived from epSOSEntityNamePartQualifier 2.16.840.1.113883.5.43
hl7:given
1 … *MPatient's Given NameR1.1.3
 
target
ehdsi-dataelement-164draft Given Name draft eHDSI Data Set
ehdsi-dataelement-247draft Given Name draft eHDSI Data Set
ehdsi-dataelement-310draft Given Name draft eHDSI Data Set
ehdsi-dataelement-350draft Given Name draft eHDSI Data Set
hl7:administrativeGenderCode
CE.EPSOS1 … 1RPatient's GenderR1.2
 
target
ehdsi-dataelement-159draft Gender Code draft eHDSI Data Set
ehdsi-dataelement-244draft Gender draft eHDSI Data Set
ehdsi-dataelement-307draft Gender draft eHDSI Data Set
ehdsi-dataelement-344draft Gender Code draft eHDSI Data Set
@nullFlavor
cs0 … 1FUNK
 CONF
The value of @code shall be drawn from value set 1.3.6.1.4.1.12559.11.10.1.3.1.42.34 eHDSIAdministrativeGender (DYNAMIC)
hl7:birthTime
TS1 … 1MPatient's Date of Birth. The patient date of birth may be a partial date such as only the year.R1.3
 
target
ehdsi-dataelement-161draft Date of Birth draft eHDSI Data Set
ehdsi-dataelement-242draft Date of Birth draft eHDSI Data Set
ehdsi-dataelement-346draft Date of Birth draft eHDSI Data Set
hl7:guardian
0 … *R

The guardians of a patient shall be recorded in the <guardian> element beneath the /ClinicalDocument/recordTarget/patientRole/patient XML - <patient> element. Other patient contacts are described using the /ClinicalDocument/participant structure. The <associatedEntity> element defines the type of contact.

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 (eHDSIPersonalRelationship 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 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.

R1.7.A
@classCode
cs1 … 1FGUARD
@nullFlavor
cs0 … 1 Use nullFlavor if unknown or if no information is applicable
 Example<guardian classCode="GUARD">
  <templateId root="1.3.6.1.4.1.19376.1.5.3.1.2.4"/>  <addr>
    <streetAddressLine>2222 Home Street</streetAddressLine>    <city>London</city>    <state>London</state>    <postalCode>A1B 2C3</postalCode>    <country>UK</country>  </addr>
  <telecom value="tel:+452070256161"/>  <telecom value="mailto:jsmith@myprovider.co.uk"/>  <guardianPerson>
    <name>
      <given>John</given>      <family>Español Smith</family>    </name>
  </guardianPerson>
</guardian>
hl7:templateId
II.EPSOS1 … 1MTemplate id for IHE PCC Patient ContactsR1.7.A
@root
uid1 … 1F1.3.6.1.4.1.19376.1.5.3.1.2.4
hl7:addr
AD.EPSOS1 … 1RThe guardian’s address element is required. 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 presentR1.7.A
@nullFlavor
cs0 … 1FNI
hl7:streetAddressLine
0 … *RGuardian's Number of Street/Guardian's Number of StreetR1.7dots.3.2
hl7:city
0 … 1RGuardian's CityR1.7dots.3.3
hl7:postalCode
0 … 1RGuardian's Postal CodeR1.7dots.3.4
hl7:state
0 … 1RGuardian's State or ProvinceR1.7dots.3.5
hl7:country
0 … 1RGuardian's Country. When used addr.country it is always bound to the eHDSICountry value setR1.7dots.3.6
 ConstraintThe content of this element SHALL be selected from ValueSet eHDSICountry urn:oid:1.3.6.1.4.1.12559.11.10.1.3.1.42.4
hl7:telecom
TEL1 … *RGuardian’s telephone number / Patient e-mail address. The guardian telephone or e-mail element is required. If 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 Optionalities and Cardinalities of the following two items shall be interpreted according to this rule: e.g. is not expected to have two nullFlavored telecom elements.R1.7dots.4.2
@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 eHDSITelecomAddress (DYNAMIC)
@nullFlavor
cs0 … 1FNI
hl7:guardianPerson
1 … 1RR1.7.A
hl7:name
PN1 … *RPatient Guardian's NameIHE PCC
Choice2 … *Elements to choose from:
  • hl7:family
  • hl7:given
hl7:family
1 … *RPatient Guardian's Family Name/SurnameR1.7.A.1
hl7:given
1 … *RPatient Guardian's Given NameR1.7.A.2
hl7:languageCommunication
0 … *RThis element is derived from the IHE template LanguageCommunication (1.3.6.1.4.1.19376.1.5.3.1.2.1), however this template does not need the element preferenceInd because the language is already said to be the "preferred language".eHDSdotsrget
hl7:languageCode
CS1 … 1RPatient’s preferred language
  • The language code SHALL be in the form nn-CC.
  • The nn portion SHALL be an ISO-639-1 language code in lower case derived by the Value Set eHDSILanguage.
  • The CC portion SHALL be an ISO-3166 country code in upper case derived by the value Set eHDSICountry.
R1.7
 CONF
The value of @code shall be drawn from value set 1.3.6.1.4.1.12559.11.10.1.3.1.42.6 eHDSILanguage (DYNAMIC)
 Example<languageCode code="en-GB"/>
 Schematron assertrolered 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 eHDSILanguage and CC is ISO-3166 eHDSICountry