Template

Show index

Template Patient - recordTarget 2017‑11‑22 16:58:26

Id2.16.756.5.30.1.1.10.2.48Effective Date2017‑11‑22 16:58:26
Statusdraft DraftVersion Label2017
Namecdacheresp_header_PatientDisplay NamePatient - recordTarget
DescriptionA human patient for whom this CDA document instance was created. 
ClassificationCDA Header Level Template
Open/ClosedOpen (other than defined elements are allowed)
Associated with
Associated with 8 concepts
IdNameData Set
cdachresp-dataelement-136draft Postadresse (eCH-0010) draft  1
cdachresp-dataelement-11draft Geschlecht draft  1
cdachresp-dataelement-135draft AHV-Nummer draft  1
cdachresp-dataelement-2draft Patient draft  1
cdachresp-dataelement-7draft PLS-ID draft  1
cdachresp-dataelement-10draft Geburtsdatum draft  1
cdachresp-dataelement-225draft (de-CH) Adresszeile 1 draft  1
cdachresp-dataelement-447draft Identifikation draft  1
Used by / Uses
Used by 0 transactions and 0 templates, Uses 4 templates
Uses as NameVersion
2.16.756.5.30.1.1.10.9.29Includepending PLS-ID (2017)DYNAMIC
2.16.756.5.30.1.1.10.9.30Containmentactive Organization Compilation with GLN and name (2017)DYNAMIC
2.16.756.5.30.1.1.10.9.34Containmentdraft Person Name Information Compilation - eCH-0011 (2022)DYNAMIC
2.16.756.5.30.1.1.10.9.35Containmentdraft Address Information Compilation - eCH-0010 (2022)DYNAMIC
RelationshipAdaptation: template 2.16.756.5.30.1.1.10.2.1 (2017‑09‑05 15:18:06)
Specialization: template 2.16.840.1.113883.10.12.101 CDA recordTarget (2005‑09‑07)
ref
ad1bbr-
Example
Sample patient
<recordTarget>
  <patientRole>
    <!-- cdachresp-dataelement-135 navs13 -->
    <id root="2.16.756.5.32" extension="7560123123499"/>    <!-- OID SRZ, here dummy -->
    <id root="2.16.756.5.30.1.9999999999.2" extension="762354"/>    <addr use="HP">
      <streetName>Bahnhofstrasse</streetName>      <houseNumber>1</houseNumber>      <city>Zürich</city>      <postalCode>8003</postalCode>      <country>CH</country>    </addr>
    <patient>
      <name>
        <!-- cdachresp-dataelement-8 -->
        <family>Muster</family>        <!-- cdachresp-dataelement-9 -->
        <given>Peter</given>      </name>
      <!-- cdachresp-dataelement-11 -->
      <administrativeGenderCode code="M" codeSystem="2.16.840.1.113883.5.1" displayName="Male" codeSystemName="HL7 AdministrativeGender"/>      <!-- cdachresp-dataelement-10 -->
      <birthTime value="19611001"/>    </patient>
  </patientRole>
</recordTarget>
Example
Sample patient with PLS-ID
<recordTarget>
  <patientRole>
    <id extension="MU43221" root="2.16.756.5.30.1.143.20"/>    <patient>
      <name>
        <!-- cdachresp-dataelement-8 -->
        <family nullFlavor="UNK"/>        <!-- cdachresp-dataelement-9 -->
        <given nullFlavor="UNK"/>      </name>
      <!-- cdachresp-dataelement-11 -->
      <administrativeGenderCode code="M" codeSystem="2.16.840.1.113883.5.1" displayName="Male" codeSystemName="HL7 AdministrativeGender"/>      <!-- cdachresp-dataelement-10 -->
      <birthTime nullFlavor="UNK"/>    </patient>
  </patientRole>
</recordTarget>
ItemDTCardConfDescriptionLabel
hl7:recordTarget
1 … 1R A human patient for whom this CDA document instance was created.
  • Target patient
    The HL7 CDA R2 (2005) standard allows multiple patients.
    In order to ensure that the information in a CDA document is unambiguously assigned to one and only patient, a CDA-CH V2 based document MUST contain exactly one patient.
    Special cases: In exceptional cases (e.g., new-born twins, both having jaundice), multiple documents MUST be created (all of the same content, but each with a unique patient).

  • Patient identifiers
    Multiple ids (patient identification number) MAY be declared.
    If multiple ids are known, it is highly recommended to declare all known ids. Especially in cases where the CDA document instance is kind of an answer to a preceding order (independent of its data format), all ids specified by the ordering system SHALL be declared in the CDA document instance. This allows the receiver to assign its internal patient identification.
    The patient identification number MUST be grouped with the OID of its assigning system. The patient identification number MUST be unique within the system identified by the OID.
    The declared OID MUST be found in one of the public OID registries, such as oid.refdata.ch (preferred), oid-info.com, hl7.org/oid, www.dimdi.de/static/de/klassi/oid/, gesundheit.gv.at/OID_Frontend/ etc.
    OIDs that can't be found in a public OID registry are NOT ALLOWED.

  • Pseudonymizing
    In special cases, the demographic data of the patient are not allowed to be transmitted or they have to be pseudonymized.
    While HL7 CDA or its derivatives like CDA-CH or Swiss exchange formats nevertheless require these elements in the XML structure, the affected values MUST be replaced by a nullFlavor of type "MSK" (masked), in order to support the required data format structure and simultaneously to shield the real data.

cdacdotsient
hl7:patientRole
1 … 1Rcdacdotsient
 
target
cdachresp-dataelement-2draft Patient draft  1
Choice1 … *Elements to choose from:
Included0 … 1 from 2.16.756.5.30.1.1.10.9.29 PLS-ID (DYNAMIC)
hl7:id
II0 … 1M

noticeWarning: If isMandatory=true, minimumMultiplicity shall be greater than 0.

PLS‑ID
@root
uid1 … 1F2.16.756.5.30.1.143.20
@extension
st1 … 1R
hl7:id
II1 … *RThe patient's id.cdacdotsient
 
target
cdachresp-dataelement-135draft AHV-Nummer draft  1
cdachresp-dataelement-7draft PLS-ID draft  1
cdachresp-dataelement-447draft Identifikation draft  1
@extension
st1 … 1RThe id itself. It MUST be unique within the issuing system.
@root
uid1 … 1RThe OID of the system that issued the id. OIDs of code systems, which are published in a public OID registry are REQUIRED. Others are NOT ALLOWED.
hl7:addr
AD0 … *The patient's address.
Contains 2.16.756.5.30.1.1.10.9.35 Address Information Compilation - eCH-0010 (DYNAMIC)
cdacdotsient
 
target
cdachresp-dataelement-136draft Postadresse (eCH-0010) draft  1
cdachresp-dataelement-225draft (de-CH) Adresszeile 1 draft  1
hl7:telecom
TEL0 … *The patient's means of communication (phone, eMail, ...).cdacdotsient
hl7:patient
1 … 1RContains 2.16.756.5.30.1.1.10.9.34 Person Name Information Compilation - eCH-0011 (DYNAMIC)cdacdotsient
hl7:administrativeGenderCode
CE1 … 1RThe patient's gender according to the Swiss EPR XDS.b metadata.cdacdotsient
@displayName
st1 … 1R
@code
cs1 … 1R
 
target
cdachresp-dataelement-11draft Geschlecht draft  1
@codeSystemName
st1 … 1FHL7 AdministrativeGender
@codeSystem
oid1 … 1F2.16.840.1.113883.5.1
 CONF
The value of @code shall be drawn from value set 2.16.756.5.30.1.127.3.10.1.25 EprGender (DYNAMIC)
hl7:birthTime
TS.CH.TZ1 … 1The patient's birthdate.cdacdotsient
 
target
cdachresp-dataelement-10draft Geburtsdatum draft  1
hl7:maritalStatusCode
CE0 … 1The patient's marital status.cdacdotsient
@displayName
st1 … 1R
@code
cs1 … 1R
@codeSystemName
st1 … 1FHL7 MaritalStatus
@codeSystem
oid1 … 1F2.16.840.1.113883.1.11.12212
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.12212 Marital Status (DYNAMIC)
hl7:translation
0 … *A translation of the code to another coding systemcdacdotsient
@displayName
st1 … 1R
@code
cs1 … 1R
@codeSystemName
st1 … 1R
@codeSystem
oid1 … 1R
hl7:religiousAffiliationCode
CE0 … 1The patient's religion.cdacdotsient
@nullFlavor
cs0 … 1FNAV
@displayName
st0 … 1 
@code
cs0 … 1 
@codeSystemName
st0 … 1 
@codeSystem
oid0 … 1 
hl7:originalText
ED0 … 1CThe patient's religion as plain text.cdacdotsient
 Schematron assertrolered error 
 test(@nullFlavor='NAV' and originalText and not(@codeSystem or @codeSystemName or @code or @displayName)) or (@codeSystem and @codeSystemName and @code and @displayName) 
 MessageEither a code described by code, codeSystem, codeSystemName and displayName or originalText and nullFlavor="NAV" is REQUIRED. 
hl7:birthplace
0 … 1The patient's birthplace.cdacdotsient
hl7:place
1 … 1cdacdotsient
hl7:name
EN0 … 1The patient's birthplace name.cdacdotsient
hl7:addr
AD1 … 1RThe patient's birthplace address.
Contains 2.16.756.5.30.1.1.10.9.35 Address Information Compilation - eCH-0010 (DYNAMIC)
cdacdotsient
hl7:languageCommunication
0 … *RThe patient's language skills.cdacdotsient
hl7:languageCode
CS1 … 1cdacdotsient
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.11526 HumanLanguage (DYNAMIC)
hl7:modeCode
CE0 … 1cdacdotsient
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.12249 LanguageAbilityMode (DYNAMIC)
hl7:proficiencyLevelCode
CE0 … 1cdacdotsient
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.12199 LanguageAbilityProficiency (DYNAMIC)
hl7:preferenceInd
BL0 … 1In case of @value=true it is the patient's correspondence language.cdacdotsient
hl7:providerOrganization
0 … 1The organization who took care of the patient in the same context with the current CDA document. E.g. entry of the Medreg, FMH Index or the Health Organisation Index (HOI) of the Swiss EPR.
Contains 2.16.756.5.30.1.1.10.9.30 Organization Compilation with GLN and name (DYNAMIC)
cdacdotsient