Templates

Show index

Template Patient - recordTarget 2017‑09‑05 15:18:06

Id2.16.756.5.30.1.1.10.2.1
ref
hl7chcda-
Effective Date2017‑09‑05 15:18:06
Statusdraft DraftVersion 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.
ClassificationCDA Header Level Template
Open/ClosedOpen (other than defined elements are allowed)
RelationshipSpecialization: template 2.16.840.1.113883.10.12.101 CDA recordTarget (2005‑09‑07)
ref
ad1bbr-
Example
Sample patient
<recordTarget>
  <patientRole>
    <id extension="898989" root="2.999"/>    <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 extension="7608888888888" root="2.51.1.3"/>      <name>Gruppenpraxis CH, Dr. med. Allzeit Bereit</name>    </providerOrganization>
  </patientRole>
</recordTarget>
Example
Pseudonymizing with initials
<recordTarget>
  <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.

cdacdotsient
hl7:patientRole
1 … 1Rcdacdotsient
hl7:id
II1 … *RThe patient's id.cdacdotsient
@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
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
@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
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:guardian
0 … *The patient's guardian.cdacdotsient
hl7:id
II0 … *The guardian's id.cdacdotsient
hl7:code
CE0 … 1The guardian's role.cdacdotsient
@nullFlavor
cs0 … 1 
@displayName
st0 … 1 
@codeSystemName
st0 … 1FHL7RoleCode
@codeSystem
oid0 … 1F2.16.840.1.113883.5.111
@code
cs0 … 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)
cdacdotsient
hl7:telecom
TEL0 … *The guardian's means of communication (phone, eMail, ...).cdacdotsient
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)
cdacdotsient
hl7:guardianOrganization
The guardian's as an organization.
Contains 2.16.756.5.30.1.1.10.9.24 Organization Compilation with name (DYNAMIC)
cdacdotsient
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

Template CDA recordTarget Person 2015‑12‑14

Id2.16.756.5.30.1.1.10.2.1
ref
hl7chcda-
Effective Date2015‑12‑14
Statusretired RetiredVersion Label
NameCDARecordTargetPersonDisplay NameCDA recordTarget Person
Description
(de-CH) Im Element recordTarget wird der Patient bezeichnet. Es wird genau ein Patient angegeben.
Behandlung von Spezialfällen:
Spezialfall 1: Einem neugeborenen Kind mit einem Neugeborenen- Ikterus werden Blutgruppen-Dokumente seiner Mutter zugeordnet. Patient ist dabei zwar die Mutter, im recordTarget wird aber das Kind angegeben.
Spezialfall 2: In anderen Fällen, auch wenn das Kind noch ungeboren ist, ist das Kind participant mit dem entsprechenden ParticipationType Code IND (indirect target).
ClassificationCDA Header Level Template
Open/ClosedOpen (other than defined elements are allowed)
RelationshipSpecialization: template 2.16.840.1.113883.10.12.101 CDA recordTarget (2005‑09‑07)
ref
ad1bbr-
Example
Example
<recordTarget>
  <patientRole>
    <id extension="898989" root="2.16.756.5.30.999999999999"/>    <addr use="HP">
      <streetName>Leidensweg</streetName>      <houseNumber>10</houseNumber>      <postalCode>9876</postalCode>      <city>Specimendorf</city>      <country>CH</country>    </addr>
    <telecom nullFlavor="MSK"/>    <patient>
      <name>
        <given>Sesuna</given>        <family>Tigrinja</family>      </name>
      <administrativeGenderCode code="F" codeSystem="2.16.840.1.113883.5.1"/>      <birthTime value="20000404"/>    </patient>
    <providerOrganization>
      <id extension="7608888888888" root="1.3.88"/>      <name>Gruppenpraxis CH, Dr. med. Allzeit Bereit</name>    </providerOrganization>
  </patientRole>
</recordTarget>
ItemDTCardConfDescriptionLabel
hl7:recordTarget
1 … *R(de-CH) Der Patient kann gemäss Arztbrief mehrmals angegeben werden. Damit die Informationen in einem CDA Dokument unmissverständlich dem richtigen Patienten zugeordnet werden können, legen wir für den Einsatz in der Schweiz fest, dass pro CDA Dokument genau ein Patient angegeben werden muss.
Spezialfälle:
Gemäss CDA könnte sich das gleiche Dokument auf mehrere Personen beziehen (z.B. bei Zwillingen, die die Neugeborenen-Gelbsucht haben). Da es sich hier um Ausnahmefälle handelt, die nicht mit der Regel <CH-PATC> vereinbar sind, müssen in solchen Fällen mehrere Dokumente erstellt werden (alle mit demselben Inhalt, aber jedes mit einem eindeutigen Patienten).
CDARdotsrson
@typeCode
cs0 … 1FRCT
@contextControlCode
cs0 … 1FOP
hl7:patientRole
1 … 1R(de-CH) Enthält die Patientenidentifikationen. Es werden nur OIDs von Codesystemen verwendet, welche im öffentlichen OID Register für das schweizerische Gesundheitswesen (oid.refdata.ch) publiziert sind. Folgende OIDs sollen eingesetzt werden:
  • Unique Patient Identifier (UPID)
  • Master Patient Index (MPI)
  • eue Sozialversicherungsnummer (AHV/AVS 13-digit) (sofern diese dazu gesetzlich zugelassen wird)
  • Bisherige AHV-Nr (AHV/AVS 11-digit) in Kombination mit:
  • Proprietäre Nummern publizierter Institutionen inkl. Mandanten (z.B. Patienten- / Fallnummer der behandelnden Institution)
Wichtig:
  • PatientRole erlaubt es, mehrere Patientenidentifikationen anzugeben. Das Element id (Patienten-Identifikationsnummer) kann also n mal vorkommen.
  • Wenn mehrere Identifikationen im erstellenden System bekannt sind, sollen alle bekannten IDs angegeben werden.
  • Bei Antworten auf eine Anfrage sollen die, vom anfragenden System angegebenen IDs wieder zurückgegeben werden.
Damit wird ermöglicht, dass der Empfänger die Zuordnung zur internen Patientenidentifikation mit dem von ihm bevorzugten System und nicht mit dem, vom Sender bevorzugten System vorgenommen werden kann.
CDARdotsrson
@classCode
cs0 … 1FPAT
hl7:id
II1 … *RCDARdotsrson
 Example<id extension="123.71.332.115" root="2.16.756.5.31"/>
 Example<id extension="65465" root=" 2.16.756.5.30.1.199.2.9"/>
hl7:addr
AD0 … *CDARdotsrson
hl7:telecom
TEL0 … *CDARdotsrson
hl7:patient
0 … 1CDARdotsrson
@classCode
cs0 … 1FPSN
@determinerCode
cs0 … 1FINSTANCE
hl7:name
PN0 … *CDARdotsrson
hl7:administrativeGenderCode
CE0 … 1CDARdotsrson
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.1 Administrative Gender (HL7 V3) (DYNAMIC)
hl7:birthTime
TS0 … 1(de-CH) Die Angabe des Geburtsortes ist optional. Wenn er aber angegeben wird, ist das Land zwingend anzugeben.CDARdotsrson
hl7:maritalStatusCode
CE0 … 1CDARdotsrson
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.12212 Marital Status (DYNAMIC)
hl7:religiousAffiliationCode
CE0 … 1CDARdotsrson
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.19185 ReligiousAffiliation (DYNAMIC)
hl7:guardian
0 … *CDARdotsrson
@classCode
cs1 … 1FGUARD
hl7:id
II0 … *CDARdotsrson
hl7:code
CE0 … 1CDARdotsrson
@codeSystem
CONF0 … 1F2.16.840.1.113883.5.111
hl7:addr
AD0 … *CDARdotsrson
hl7:telecom
TEL0 … *CDARdotsrson
Choice1 … 1Elements to choose from:
  • hl7:guardianPerson
  • hl7:guardianOrganization
hl7:guardianPerson
CDARdotsrson
Included from 2.16.756.5.30.1.1.10.9.10 (DYNAMIC)
 Include
alertError: Cannot find template "2.16.756.5.30.1.1.10.9.10" (DYNAMIC)
hl7:guardianOrganization
CDARdotsrson
Included from 2.16.756.5.30.1.1.10.9.11 (DYNAMIC)
 Include
alertError: Cannot find template "2.16.756.5.30.1.1.10.9.11" (DYNAMIC)
hl7:birthplace
0 … 1CDARdotsrson
@classCode
cs0 … 1FBIRTHPL
hl7:place
1 … 1RCDARdotsrson
@classCode
cs0 … 1FPLC
@determinerCode
cs0 … 1FINSTANCE
hl7:addr
AD0 … 1CDARdotsrson
hl7:languageCommunication
0 … *CDARdotsrson
hl7:languageCode
CS0 … 1CDARdotsrson
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.11526 HumanLanguage (DYNAMIC)
hl7:modeCode
CE0 … 1CDARdotsrson
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.12249 LanguageAbilityMode (DYNAMIC)
hl7:proficiencyLevelCode
CE0 … 1CDARdotsrson
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.12199 LanguageAbilityProficiency (DYNAMIC)
hl7:preferenceInd
BL0 … 1CDARdotsrson
hl7:providerOrganization
0 … 1(de-CH) Hier wird die EAN/GLN Nummer des Leistungserbringers gemäss FMH Index angegeben, der den Patienten im Zusammenhang mit dem aktuellen medizinischen Dokument betreut hat.CDARdotsrson
 Example<id extension="7601234567890" root="1.3.88"/>
Included from 2.16.756.5.30.1.1.10.9.11 (DYNAMIC)
 Include
alertError: Cannot find template "2.16.756.5.30.1.1.10.9.11" (DYNAMIC)