Template

Show index

Template Patient - recordTarget 2018‑04‑18

Id2.16.756.5.30.1.1.10.2.1
ref
hl7chcda-
Effective Date2018‑04‑18
Statusactive ActiveVersion Label2017
Namecdach_header_PatientDisplay NamePatient - recordTarget
DescriptionA human patient for whom this CDA document instance was created. All CDA-CH V2 derivatives, i.e. Swiss exchange formats MUST use this template by either reference or specialisation.
ContextParent nodes of template element with id 2.16.756.5.30.1.1.10.2.1
LabelCDA‑CH V2
ClassificationCDA Header Level Template
Open/ClosedOpen (other than defined elements are allowed)
Associated with
Associated with 12 concepts
IdNameData Set
hl7chcda-dataelement-47draft addressInformation draft CDA-CH V2 2017
ref
hl7chcda-
hl7chcda-dataelement-227draft Gender draft CDA-CH V2 2017
ref
hl7chcda-
hl7chcda-dataelement-186draft maritalStatus draft CDA-CH V2 2017
ref
hl7chcda-
hl7chcda-dataelement-181draft dateOfBirth draft CDA-CH V2 2017
ref
hl7chcda-
hl7chcda-dataelement-164draft languageOfCorrespondance draft CDA-CH V2 2017
ref
hl7chcda-
hl7chcda-dataelement-162draft personIdentification draft CDA-CH V2 2017
ref
hl7chcda-
hl7chcda-dataelement-183draft sex draft CDA-CH V2 2017
ref
hl7chcda-
hl7chcda-dataelement-226draft Date of birth draft CDA-CH V2 2017
ref
hl7chcda-
hl7chcda-dataelement-182draft placeofBirth draft CDA-CH V2 2017
ref
hl7chcda-
hl7chcda-dataelement-184draft religion draft CDA-CH V2 2017
ref
hl7chcda-
hl7chcda-dataelement-228draft Identification number draft CDA-CH V2 2017
ref
hl7chcda-
hl7chcda-dataelement-229draft Address (es) draft CDA-CH V2 2017
ref
hl7chcda-
Used by / Uses
Used by 0 transactions and 0 templates, Uses 5 templates
Uses as NameVersion
2.16.756.5.30.1.1.10.9.24Containmentactive Organization Compilation with name (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
2.16.756.5.30.1.1.10.9.49Includedraft Original Text Reference (2021)DYNAMIC
RelationshipSpecialization: template 2.16.840.1.113883.10.12.101 CDA recordTarget (2005‑09‑07)
ref
ad1bbr-
Example
Sample patient
<recordTarget>
  <templateId root="2.16.756.5.30.1.1.10.2.1"/>  <patientRole>
    <id root="2.999" extension="898989"/>    <addr use="HP">
      <streetName>Leidensweg</streetName>      <houseNumber>10</houseNumber>      <postalCode>9876</postalCode>      <city>Specimendorf</city>      <country>CH</country>    </addr>
    <telecom use="HP" value="tel:+41.32.685.12.34"/>    <telecom use="PUB" value="mailto:sesuna.tigrinja@sampledomain.ch"/>    <patient>
      <name>
        <given>Sesuna</given>        <family>Tigrinja</family>      </name>
      <administrativeGenderCode code="F" codeSystem="2.16.840.1.113883.5.1" codeSystemName="AdministrativeGender" displayName="Female"/>      <birthTime value="20000404"/>    </patient>
    <providerOrganization>
      <id root="2.51.1.3" extension="7608888888888"/>      <name>Gruppenpraxis CH, Dr. med. Allzeit Bereit</name>    </providerOrganization>
  </patientRole>
</recordTarget>
Example
Pseudonymizing with initials
<recordTarget>
  <templateId root="2.16.756.5.30.1.1.10.2.1"/>  <patientRole>
    <id nullFlavor="MSK"/>    <addr nullFlavor="MSK"/>    <telecom nullFlavor="MSK"/>    <patient>
      <name nullFlavor="MSK">
        <family>(only first letter)</family>        <given>(only first letter)</given>      </name>
      <administrativeGenderCode nullFlavor="MSK"/>      <birthTime nullFlavor="MSK"/>    </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.

CDA‑CH V2
hl7:templateId
II1 … 1MCDA‑CH V2
@root
uid1 … 1F2.16.756.5.30.1.1.10.2.1
hl7:patientRole
1 … 1RCDA‑CH V2
hl7:id
II1 … *RThe patient's id.CDA‑CH V2
 
target
hl7chcda-dataelement-162draft personIdentification draft CDA-CH V2 2017
ref
hl7chcda-
hl7chcda-dataelement-228draft Identification number draft CDA-CH V2 2017
ref
hl7chcda-
@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.
@extension
st0 … 1 The id itself. It MUST be unique within the issuing system.
hl7:addr
AD0 … *The patient's address.
Contains 2.16.756.5.30.1.1.10.9.35 Address Information Compilation - eCH-0010 (DYNAMIC)
CDA‑CH V2
 
target
hl7chcda-dataelement-47draft addressInformation draft CDA-CH V2 2017
ref
hl7chcda-
hl7chcda-dataelement-229draft Address (es) draft CDA-CH V2 2017
ref
hl7chcda-
hl7:telecom
TEL0 … *The patient's means of communication (phone, eMail, ...).CDA‑CH V2
hl7:patient
1 … 1RContains 2.16.756.5.30.1.1.10.9.34 Person Name Information Compilation - eCH-0011 (DYNAMIC)CDA‑CH V2
hl7:administrativeGenderCode
CE1 … 1RThe patient's gender according to the Swiss EPR XDS.b metadata.CDA‑CH V2
 
target
hl7chcda-dataelement-227draft Gender draft CDA-CH V2 2017
ref
hl7chcda-
hl7chcda-dataelement-183draft sex draft CDA-CH V2 2017
ref
hl7chcda-
@code
cs1 … 1R
@codeSystem
oid1 … 1F2.16.840.1.113883.5.1
@codeSystemName
st1 … 1FHL7 AdministrativeGender
@displayName
st1 … 1R
 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 … 1RThe patient's birthdate.CDA‑CH V2
 
target
hl7chcda-dataelement-181draft dateOfBirth draft CDA-CH V2 2017
ref
hl7chcda-
hl7chcda-dataelement-226draft Date of birth draft CDA-CH V2 2017
ref
hl7chcda-
hl7:maritalStatusCode
CE0 … 1The patient's marital status.CDA‑CH V2
 
target
hl7chcda-dataelement-186draft maritalStatus draft CDA-CH V2 2017
ref
hl7chcda-
@code
cs1 … 1R
@codeSystem
oid1 … 1F2.16.840.1.113883.1.11.12212
@codeSystemName
st1 … 1FHL7 MaritalStatus
@displayName
st1 … 1R
 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 systemCDA‑CH V2
@code
cs1 … 1R
@codeSystem
oid1 … 1R
@codeSystemName
st1 … 1R
@displayName
st1 … 1R
hl7:religiousAffiliationCode
CE0 … 1The patient's religion.CDA‑CH V2
 
target
hl7chcda-dataelement-184draft religion draft CDA-CH V2 2017
ref
hl7chcda-
@nullFlavor
cs0 … 1FNAV
@code
cs0 … 1 
@codeSystem
oid0 … 1 
@codeSystemName
st0 … 1 
@displayName
st0 … 1 
Included0 … 1C from 2.16.756.5.30.1.1.10.9.49 Original Text Reference (DYNAMIC)
The human-readable text MUST be generated automatically from the structured information of this element. The text element MUST contain the reference to the corresponding text in the human readable part, ONLY.
hl7:originalText
ED0 … 1CCDA‑CH V2
hl7:reference
TEL1 … 1MThe reference to the corresponding text in the human readable part must be specified by reference to content[@ID]: reference[@value='#xxx']CDA‑CH V2
@value
1 … 1RReference to the narrative part of the section in the format '#xxx', where xxx is the ID of the corresponding element.
 Schematron assertrolered error 
 teststarts-with(@value,'#') 
 MessageThe @value attribute content MUST conform to the format '#xxx', where xxx is the ID of the corresponding 'content' element. 
 Variable letNameidvalue 
 Valuesubstring-after(@value,'#') 
 Schematron assertrolered error 
 testancestor::hl7:structuredBody//*[@ID=$idvalue] 
 MessageNo narrative text found for this reference (no content element within this document has an ID that corresponds to '<value-of select="$idvalue"/>'). 
 Schematron assertrolered error 
 testparent::*/text()=ancestor::hl7:structuredBody//*[@ID=$idvalue]/text() 
 MessageThe originalText content MUST be identical to the narrative text for this reference. 
 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:guardian
0 … *The patient's guardian.CDA‑CH V2
hl7:id
II0 … *The guardian's id.CDA‑CH V2
@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.
@extension
st0 … 1 The id itself. It MUST be unique within the issuing system.
hl7:code
CE0 … 1The guardian's role.CDA‑CH V2
@nullFlavor
cs0 … 1 
@code
cs0 … 1 
@codeSystem
oid0 … 1F2.16.840.1.113883.5.111
@codeSystemName
st0 … 1FHL7RoleCode
@displayName
st0 … 1 
 Schematron assertrolered error 
 test(not(@nullFlavor) and @displayName and @code and @codeSystem and @codeSystemName) or (@nullFlavor and not(@displayName or @code or @codeSystem or @codeSystemName)) 
 MessageEither nullFlavor or a valid code is required. 
hl7:addr
AD0 … *The guardian's address.
Contains 2.16.756.5.30.1.1.10.9.35 Address Information Compilation - eCH-0010 (DYNAMIC)
CDA‑CH V2
 
target
hl7chcda-dataelement-47draft addressInformation draft CDA-CH V2 2017
ref
hl7chcda-
hl7:telecom
TEL0 … *The guardian's means of communication (phone, eMail, ...).CDA‑CH V2
Choice1 … 1Elements to choose from:
hl7:guardianPerson
The guardian's as a person.
Contains 2.16.756.5.30.1.1.10.9.34 Person Name Information Compilation - eCH-0011 (DYNAMIC)
CDA‑CH V2
hl7:guardianOrganization
The guardian's as an organization.
Contains 2.16.756.5.30.1.1.10.9.24 Organization Compilation with name (DYNAMIC)
CDA‑CH V2
hl7:birthplace
0 … 1The patient's birthplace.CDA‑CH V2
 
target
hl7chcda-dataelement-182draft placeofBirth draft CDA-CH V2 2017
ref
hl7chcda-
hl7:place
1 … 1CDA‑CH V2
hl7:name
EN0 … 1The patient's birthplace name.CDA‑CH V2
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)
CDA‑CH V2
hl7:languageCommunication
0 … *The patient's language skills.CDA‑CH V2
hl7:languageCode
CS1 … 1CDA‑CH V2
 
target
hl7chcda-dataelement-164draft languageOfCorrespondance draft CDA-CH V2 2017
ref
hl7chcda-
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.11526 HumanLanguage (DYNAMIC)
hl7:modeCode
CE0 … 1CDA‑CH V2
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.12249 LanguageAbilityMode (DYNAMIC)
hl7:proficiencyLevelCode
CE0 … 1CDA‑CH V2
 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.CDA‑CH V2
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)
CDA‑CH V2