Template 2.16.756.5.30.1.1.10.9.40 - RESPHeaderTemplateCompilation

Template RESP Header Template Compilation

Id 2.16.756.5.30.1.1.10.9.40 Effective Date valid from 2017‑11‑20 13:35:46

Status Draft Version Label 2017

Name RESPHeaderTemplateCompilation Display Name RESP Header Template Compilation

Description Header Templates for CDA-CH RESP

Classification Template type not specified

Open/Closed Open (other than defined elements are allowed)

Used by / Uses

Used by 0 transactions and 2 templates, Uses 23 templates

Used by	as	Name	Version
2.16.756.5.30.1.1.10.1.2	Include	EmergencyMedicalServiceProtocol (2017)	2017‑06‑13 17:19:29
2.16.756.5.30.1.1.10.1.2		EmergencyMedicalServiceProtocol (2017)	2017‑05‑31 17:19:29
	Circular reference found with cdachresp-template-document-2, please check
Uses	as	Name	Version
2.16.756.5.30.1.1.10.2.23	Include	Document Id (2017)	DYNAMIC
2.16.756.5.30.1.1.10.2.45	Include	Document Code RESP (2017)	DYNAMIC
2.16.756.5.30.1.1.10.2.19	Include	Document Confidentiality Code (2017)	DYNAMIC
2.16.756.5.30.1.1.10.2.22	Include	Document Language (2017)	DYNAMIC
2.16.756.5.30.1.1.10.2.20	Include	Document Set Id and Version Number (2017)	DYNAMIC
2.16.756.5.30.1.1.10.2.1	Include	Patient - recordTarget (2017)	DYNAMIC
2.16.756.5.30.1.1.10.9.23	Include	Author (2017)	DYNAMIC
2.16.756.5.30.1.1.10.2.7	Include	Data Enterer (2017)	DYNAMIC
2.16.840.1.113883.10.12.154	Include	CDA Informant	DYNAMIC
2.16.756.5.30.1.1.10.2.3	Include	Custodian (2017)	DYNAMIC
2.16.756.5.30.1.1.10.2.4	Include	Recipient - informationRecipient (2017)	DYNAMIC
2.16.756.5.30.1.1.10.2.5	Include	Legal Authenticator (2017)	DYNAMIC
2.16.756.5.30.1.1.10.2.6	Include	Authenticator (2017)	DYNAMIC
2.16.756.5.30.1.1.10.2.40	Include	Employer - participant (2017)	DYNAMIC
2.16.756.5.30.1.1.10.2.15	Include	Insurance - participant (2017)	DYNAMIC
2.16.756.5.30.1.1.10.2.14	Include	Insurance Card - participant (2017)	DYNAMIC
2.16.756.5.30.1.1.10.2.49	Include	Invoice Recipient (2017)	DYNAMIC
2.16.756.5.30.1.1.10.2.43	Include	Patient Contact - participant (2017)	DYNAMIC
2.16.756.5.30.1.1.10.2.16	Include	Order Reference - inFulfillmentOf (2017)	DYNAMIC
2.16.756.5.30.1.1.10.2.46	Include	Health Service - documentationOf (2017)	DYNAMIC
2.16.756.5.30.1.1.10.2.13	Include	Document Replacement - relatedDocument (2017)	DYNAMIC
2.16.840.1.113883.10.12.114	Include	CDA Authorization	DYNAMIC
2.16.840.1.113883.10.12.113	Include	CDA componentOf	DYNAMIC

Relationship Specialization: template 2.16.756.5.30.1.1.10.9.36 (2017‑11‑09 11:38:30)

Example

<hl7:title>title</hl7:title><hl7:effectiveTime value="20180207155727+01:00"/>

Item DT Card Conf Description Label

Included 1 … 1 M from 2.16.756.5.30.1.1.10.2.23 Document Id (DYNAMIC)

hl7:id II 1 … 1 M A unique identifier for each CDA document instance. (RESion)

@extension st 0 NP NP/not present

@root uid 1 … 1 R The document's id as Globally Unique Identifier (GUID).

Included 1 … 1 M from 2.16.756.5.30.1.1.10.2.45 Document Code RESP (DYNAMIC)

hl7:code CE 1 … 1 M The LOINC code for this document is 67796-3 (RESion)

@code st 1 … 1 F 67796-3

@codeSystem oid 1 … 1 F 2.16.840.1.113883.6.1

@codeSystemName st 1 … 1 F LOINC

@displayName st 1 … 1 F EMS Patient Care Report

hl7:translation CD 1 … 1 R A translation to the Swiss EPR XDS.b metadata SHALL be specified. (RESion)

@code st 1 … 1 F 371535009

@codeSystem oid 1 … 1 F 2.16.840.1.113883.6.96

@codeSystemName st 1 … 1 F SNOMED CT

@displayName st 1 … 1 F Transfer summary report

hl7:title ST 1 … 1 M EmergencyServiceProtocol (RESion)

hl7:effectiveTime TS.CH.TZ 1 … 1 M The document's creation date and time. If this document replaces a previous version (linked via parentDocument), this is the date and time of the new version. (RESion)

Included 1 … 1 M from 2.16.756.5.30.1.1.10.2.19 Document Confidentiality Code (DYNAMIC)

hl7:confidentialityCode CE (required) 1 … 1 M Swiss Realm of Confidentiality Code according to the Swiss EPR regulation. (RESion)

@code cs 1 … 1 R The value of @code MUST be drawn from value set EprDocumentConfidentialityCode (2.16.756.5.30.1.127.3.10.1.5)

@codeSystem oid 1 … 1 F 2.16.840.1.113883.6.96

@codeSystemName st 1 … 1 F SNOMED CT

@displayName st 1 … 1 R The value of @displayName MUST be drawn from value set EprDocumentConfidentialityCode (2.16.756.5.30.1.127.3.10.1.5)

CONF

The value of @code shall be drawn from value set 2.16.756.5.30.1.127.3.10.1.5 EprDocumentConfidentialityCode (DYNAMIC)

Included 1 … 1 M from 2.16.756.5.30.1.1.10.2.22 Document Language (DYNAMIC)

hl7:languageCode CS 1 … 1 M The RFC 1766 (ISO-639-1 and ISO 3166) based language in which the narrative texts in this CDA document instance are written. (RESion)

CONF

The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.11526 HumanLanguage (DYNAMIC)

Included from 2.16.756.5.30.1.1.10.2.20 Document Set Id and Version Number (DYNAMIC)

hl7:setId II 1 … 1 R The setId element MUST match the document id of the very first version of that document. It MUST remain the same for all document versions. (RESion)

@extension st 0 NP NP/not present

@root uid 1 … 1 R The root attribute MUST contain the setId as Globally Unique Identifier (GUID).

hl7:versionNumber INT.NONNEG 1 … 1 R The versionNumber element MUST contain the value 1 for the very first version of that document. For later versions, the version number MUST be increased by 1 each. (RESion)

Included 1 … 1 R from 2.16.756.5.30.1.1.10.2.1 Patient - recordTarget (DYNAMIC)

hl7:recordTarget

1 … 1

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.

(RES

ion)

hl7:patientRole 1 … 1 R (RESion)

hl7:id II 1 … * R The patient's id. (RESion)

@extension st 1 … 1 R The id itself. It MUST be unique within the issuing system.

@root uid 1 … 1 R The 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 AD 0 … * The patient's address.
Contains 2.16.756.5.30.1.1.10.9.35 Address Information Compilation - eCH-0010 (DYNAMIC) (RESion)

hl7:telecom TEL 0 … * The patient's means of communication (phone, eMail, ...). (RESion)

hl7:patient 1 … 1 R Contains 2.16.756.5.30.1.1.10.9.34 Person Name Information Compilation - eCH-0011 (DYNAMIC) (RESion)

where [hl7:administrativeGenderCode [@codeSystem='2.16.840.1.113883.5.1' or concat(@code,@codeSystem)=doc('include/voc-2.16.756.5.30.1.127.3.10.1.25-DYNAMIC.xml')//valueSet [1]/conceptList/concept/concat(@code,@codeSystem)]]

hl7:administrativeGenderCode CE 1 … 1 R The patient's gender according to the Swiss EPR XDS.b metadata. (RESion)

@displayName st 1 … 1 R

@code cs 1 … 1 R

@codeSystemName st 1 … 1 F HL7 AdministrativeGender

@codeSystem oid 1 … 1 F 2.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.TZ 1 … 1 The patient's birthdate. (RESion)

hl7:maritalStatusCode CE 0 … 1 The patient's marital status. (RESion)

@displayName st 1 … 1 R

@code cs 1 … 1 R

@codeSystemName st 1 … 1 F HL7 MaritalStatus

@codeSystem oid 1 … 1 F 2.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 MaritalStatus (DYNAMIC)

hl7:translation 0 … * A translation of the code to another coding system (RESion)

@displayName st 1 … 1 R

@code cs 1 … 1 R

@codeSystemName st 1 … 1 R

@codeSystem oid 1 … 1 R

hl7:religiousAffiliationCode CE 0 … 1 The patient's religion. (RESion)

@nullFlavor cs 0 … 1 F NAV

@displayName st 0 … 1

@code cs 0 … 1

@codeSystemName st 0 … 1

@codeSystem oid 0 … 1

hl7:originalText ED 0 … 1 C The patient's religion as plain text. (RESion)

Schematron assert role error

test (@nullFlavor='NAV' and originalText and not(@codeSystem or @codeSystemName or @code or @displayName)) or (@codeSystem and @codeSystemName and @code and @displayName)

Message Either a code described by code, codeSystem, codeSystemName and displayName or originalText and nullFlavor="NAV" is REQUIRED.

hl7:guardian 0 … * The patient's guardian. (RESion)

hl7:id II 0 … * The guardian's id. (RESion)

hl7:code CE 0 … 1 The guardian's role. (RESion)

@nullFlavor cs 0 … 1

@displayName st 0 … 1

@codeSystemName st 0 … 1 F HL7RoleCode

@codeSystem oid 0 … 1 F 2.16.840.1.113883.5.111

@code cs 0 … 1

Schematron assert role error

test (not(@nullFlavor) and @displayName and @code and @codeSystem and @codeSystemName) or (@nullFlavor and not(@displayName or @code or @codeSystem or @codeSystemName))

Message Either nullFlavor or a valid code is required.

hl7:addr AD 0 … * The guardian's address.
Contains 2.16.756.5.30.1.1.10.9.35 Address Information Compilation - eCH-0010 (DYNAMIC) (RESion)

hl7:telecom TEL 0 … * The guardian's means of communication (phone, eMail, ...). (RESion)

Choice

1 … 1

Elements to choose from:

hl7:guardianPerson containing template 2.16.756.5.30.1.1.10.9.34 Person Name Information Compilation - eCH-0011 (DYNAMIC)
hl7:guardianOrganization containing template 2.16.756.5.30.1.1.10.9.24 Organization Compilation with name (DYNAMIC)

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) (RESion)

hl7:guardianOrganization The guardian's as an organization.
Contains 2.16.756.5.30.1.1.10.9.24 Organization Compilation with name (DYNAMIC) (RESion)

hl7:birthplace 0 … 1 The patient's birthplace. (RESion)

hl7:place 1 … 1 (RESion)

hl7:name EN 0 … 1 The patient's birthplace name. (RESion)

hl7:addr AD 1 … 1 R The patient's birthplace address.
Contains 2.16.756.5.30.1.1.10.9.35 Address Information Compilation - eCH-0010 (DYNAMIC) (RESion)

hl7:languageCommunication 0 … * R The patient's language skills. (RESion)

hl7:languageCode CS 1 … 1 (RESion)

CONF

The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.11526 HumanLanguage (DYNAMIC)

hl7:modeCode CE 0 … 1 (RESion)

CONF

The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.12249 LanguageAbilityMode (DYNAMIC)

hl7:proficiencyLevelCode CE 0 … 1 (RESion)

CONF

The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.12199 LanguageAbilityProficiency (DYNAMIC)

hl7:preferenceInd BL 0 … 1 In case of @value=true it is the patient's correspondence language. (RESion)

hl7:providerOrganization 0 … 1 The 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) (RESion)

where [hl7:id [@root='2.51.1.3']]

Included 1 … * M from 2.16.756.5.30.1.1.10.9.23 Author (DYNAMIC)

hl7:author 1 … * M Information about the author of a CDA document, section or entry. An author MAY be a person or a device. (RESion)

hl7:functionCode CE 1 … 1 R The functionCode MUST be taken from the Swiss EPR Value-Set for author roles. See FDHA Ordinance on the Electronic Patient Record (EPRO-FDHA), Appendix 3: Metadata, Section 2.1.
If the desired functionCode is not available in the Swiss EPR Value-Set for author roles, the code 133932002 (Other Caregiver) MUST be used. In this case, the originalText element MUST contain the description of the role.
Translations to other vocabularies are allowed. (RESion)

@displayName st 1 … 1 R

@code cs 1 … 1 R

@codeSystemName st 1 … 1 F SNOMED CT

@codeSystem oid 1 … 1 F 2.16.840.1.113883.6.96

CONF

The value of @code shall be drawn from value set 2.16.756.5.30.1.127.3.10.1.1.3 EprAuthorRole (DYNAMIC)

Example <functionCode code="106292003" codeSystem="2.16.840.1.113883.6.96" codeSystemName="SNOMED CT" displayName="Professional nurse"/>

Example <functionCode code="133932002" codeSystem="2.16.840.1.113883.6.96" codeSystemName="SNOMED CT" displayName="Other Caregiver"> <originalText>Home helper</originalText></functionCode>

Example <functionCode code="133932002" codeSystem="2.16.840.1.113883.6.96" codeSystemName="SNOMED CT" displayName="Other Caregiver"> <originalText>Laboratory technician</originalText> <translation code="3212" codeSystem="2.16.840.1.113883.2.9.6.2.7" codeSystemName="ISCO-08" displayName="Medical and pathology laboratory technicians"/></functionCode>

Schematron assert role error

test not(@code='133932002') or (originalText/text())

Message Other Caregivers description MUST be declared in the originalText element.

hl7:originalText ED 0 … 1 C Other Caregivers description MUST be declared in the originalText element. (RESion)

hl7:translation 0 … * A translation of the code to another coding system (e.g. ISCO-08: 2.16.840.1.113883.2.9.6.2.7) (RESion)

@displayName st 1 … 1 R

@code cs 1 … 1 R

@codeSystemName st 1 … 1 R

@codeSystem oid 1 … 1 R

hl7:time TS.CH.TZ 1 … 1 R Timestamp of the authorship. (RESion)

hl7:assignedAuthor 1 … 1 R (RESion)

Schematron assert role error

test not(assignedAuthoringDevice/softwareName) or (representedOrganization)

Message For device authors the element representedOrganization is REQUIRED.

hl7:id II 1 … 1 R The specification of GS1 GLN is REQUIRED. If it is not (yet) known, this MUST be declared using nullFlavor.
For persons: their personal GLN MUST be declared.
For devices or software modules: the GLN of their organization MUST be declared. (RESion)

@nullFlavor cs 0 … 1 F NAV

Temporarily unknown, will be filled later.

@extension st 0 … 1 The GS1 GLN.

@root cs 0 … 1 F 2.51.1.3

OID for GS1 GLN.

Schematron assert role error

test (@root='2.51.1.3' and @extension) or (@nullFlavor='NAV')

Message Either the GS1 GLN or nullFlavor='NAV' is REQUIRED

hl7:id II 0 … * Other ids are allowed. (RESion)

@extension st 1 … 1 R The id itself. It MUST be unique within the issuing system.

@root cs 1 … 1 R The 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.

Choice

1 … 1

Elements to choose from:

hl7:assignedPerson containing template 2.16.756.5.30.1.1.10.9.34 Person Name Information Compilation - eCH-0011 (DYNAMIC)
hl7:assignedAuthoringDevice containing template 2.16.756.5.30.1.1.10.9.21 Device Compilation with name (DYNAMIC)

hl7:assignedPerson 0 … 1 The author as a person.
Contains 2.16.756.5.30.1.1.10.9.34 Person Name Information Compilation - eCH-0011 (DYNAMIC) (RESion)

hl7:assignedAuthoringDevice 0 … 1 The author as a device.
Contains 2.16.756.5.30.1.1.10.9.21 Device Compilation with name (DYNAMIC) (RESion)

hl7:representedOrganization 0 … 1 The author's organization.
Contains 2.16.756.5.30.1.1.10.9.24 Organization Compilation with name (DYNAMIC) (RESion)

Included 0 … 1 from 2.16.756.5.30.1.1.10.2.7 Data Enterer (DYNAMIC)

hl7:dataEnterer 0 … 1 Information about the person that entered information in this CDA document. It SHALL be declared, when data recorded in this document has been entered by a person other than the author but only when this is relevant for some reason. (RESion)

hl7:templateId II 1 … 1 M (RESion)

@root uid 1 … 1 F 2.16.756.5.30.1.1.10.2.7

hl7:time TS.CH.TZ 0 … 1 Timestamp of the data input. (RESion)

hl7:assignedEntity 1 … 1 R Contains 2.16.756.5.30.1.1.10.9.12 Assigned Entity Compilation with id (DYNAMIC) (RESion)

Included 0 … * from 2.16.840.1.113883.10.12.154 CDA Informant (DYNAMIC)

hl7:informant 0 … * (RESion)

@typeCode 0 … 1 F INF

@contextControlCode 0 … 1 F OP

Choice

1 … 1

Elements to choose from:

hl7:assignedEntity containing template 2.16.840.1.113883.10.12.153 CDA AssignedEntity (DYNAMIC)
hl7:relatedEntity containing template 2.16.840.1.113883.10.12.316 CDA RelatedEntity (DYNAMIC)

hl7:assignedEntity Contains 2.16.840.1.113883.10.12.153 CDA AssignedEntity (DYNAMIC) (RESion)

hl7:relatedEntity Contains 2.16.840.1.113883.10.12.316 CDA RelatedEntity (DYNAMIC) (RESion)

Included 1 … 1 R from 2.16.756.5.30.1.1.10.2.3 Custodian (DYNAMIC)

hl7:custodian 1 … 1 R The organization in whose name this CDA document has been created (corresponds to the sender of a letter). (RESion)

hl7:assignedCustodian 1 … 1 R (RESion)

hl7:representedCustodianOrganization 1 … 1 R (RESion)

hl7:id II 1 … * M The custodian's id. (RESion)

@extension st 1 … 1 R The id itself. It MUST be unique within the issuing system.

@root uid 1 … 1 R The 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:name ON 1 … 1 R The custodian's name. (RESion)

hl7:telecom TEL 0 … 1 The custodian's means of communication (phone, eMail, ...). (RESion)

hl7:addr AD 0 … 1 The custodian's address(es).
Contains 2.16.756.5.30.1.1.10.9.35 Address Information Compilation - eCH-0010 (DYNAMIC) (RESion)

Included 1 … * M from 2.16.756.5.30.1.1.10.2.4 Recipient - informationRecipient (DYNAMIC)

hl7:informationRecipient

1 … *

A recipient of this CDA document (corresponds to the addressee of a letter - person or organization).

Recipient types:

The main recipient of the document is indicated by typeCode 'PRCP' (primary recipient).
Note: Since it makes no sense to create a CDA document without doing it for someone, in Switzerland at least one recipient MUST be declared. If the document is created for the user's own needs, the user itself or its organization will be the primary recipient.
Other recipients (copy to; Cc) are indicated with typeCode, TRC '(secondary recipient).

(RES

ion)

@typeCode cs 1 … 1 R The main recipient of the document is indicated by typeCode 'PRCP' (primary recipient).
Other recipients (copy to; Cc) are indicated with typeCode, TRC '(secondary recipient).
Note: Since it makes no sense to create a CDA document without doing it for someone, in Switzerland at least one recipient MUST be declared. If the document is created for the user's own needs, the user itself or its organization will be the primary recipient.

CONF

The value of @typeCode shall be drawn from value set 2.16.840.1.113883.1.11.19366 x_InformationRecipient (DYNAMIC)

hl7:intendedRecipient 1 … 1 R (RESion)

hl7:id II 0 … * R The recipient's identification(s). (RESion)

@extension st 1 … 1 R The id itself. It MUST be unique within the issuing system.

@root uid 1 … 1 R The 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 AD 0 … * The recipient's address(es).
Contains 2.16.756.5.30.1.1.10.9.35 Address Information Compilation - eCH-0010 (DYNAMIC) (RESion)

hl7:telecom TEL 0 … * The recipient's means of communication (phone, eMail, ...). (RESion)

hl7:informationRecipient 0 … 1 The addressee person.
Contains 2.16.756.5.30.1.1.10.9.34 Person Name Information Compilation - eCH-0011 (DYNAMIC) (RESion)

cdachresp-dataelement-462

Übergabe an

hl7:receivedOrganization 0 … 1 The addressee organization.
Contains 2.16.756.5.30.1.1.10.9.24 Organization Compilation with name (DYNAMIC) (RESion)

Included 0 … 1 from 2.16.756.5.30.1.1.10.2.5 Legal Authenticator (DYNAMIC)

hl7:legalAuthenticator 0 … 1 Information about the legal authenticator of a CDA document. A legal authenticator MUST be a person. (RESion)

hl7:time TS.CH.TZ 1 … 1 R Timestamp of the signature. (RESion)

hl7:signatureCode CS 1 … 1 R (RESion)

@code cs 1 … 1 F S

@codeSystem oid 0 NP NP/not present

@codeSystemName st 0 NP NP/not present

@displayName st 0 NP NP/not present

CONF

The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.10282 ParticipationSignature (DYNAMIC)

hl7:assignedEntity 1 … 1 R Contains 2.16.756.5.30.1.1.10.9.12 Assigned Entity Compilation with id (DYNAMIC) (RESion)

Included 0 … * from 2.16.756.5.30.1.1.10.2.6 Authenticator (DYNAMIC)

hl7:authenticator 0 … * Information about an authenticator of a CDA document. An authenticator MUST be a person. (RESion)

hl7:time TS.CH.TZ 1 … 1 R Timestamp of the signature. (RESion)

hl7:signatureCode CS 1 … 1 R (RESion)

@code cs 1 … 1 F S

@codeSystem oid 0 NP NP/not present

@codeSystemName st 0 NP NP/not present

@displayName st 0 NP NP/not present

CONF

The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.10282 ParticipationSignature (DYNAMIC)

hl7:assignedEntity 1 … 1 R Contains 2.16.756.5.30.1.1.10.9.12 Assigned Entity Compilation with id (DYNAMIC) (RESion)

Included 0 … * from 2.16.756.5.30.1.1.10.2.40 Employer - participant (DYNAMIC)

hl7:participant 0 … * Information on the patient's employer, school or other affiliated (e.g., volunteer) organization. (RESion)

@typeCode cs 1 … 1 F IND

hl7:templateId II 1 … 1 M CDA-CH v2.0 ART-DECOR model of Employer. (RESion)

@root uid 1 … 1 F 2.16.756.5.30.1.1.10.2.40

hl7:templateId 1 … * M CH-PCC ART-DECOR model of IHE PCC Employer and School Contacts. (RESion)

@root cs 1 … 1 F 2.16.756.5.30.1.1.10.2.41

hl7:templateId II 1 … 1 M IHE PCC Employer and School Contacts. (RESion)

@root uid 1 … 1 F 1.3.6.1.4.1.19376.1.5.3.1.2.2

hl7:time IVL_TS.CH.TZ 0 … 1 Validity period of contract. (RESion)

hl7:low TS.CH.TZ 1 … 1 R Start of the contract. (RESion)

hl7:high TS.CH.TZ 1 … 1 R End of the contract. (RESion)

hl7:associatedEntity 1 … 1 R (RESion)

@classCode cs 1 … 1 F CON

hl7:id II 0 … 1 R The id of the contract ([ge]: Mitarbeiternummer; [fr]: Numéro d'employé). (RESion)

@extension st 1 … 1 R The id itself. It MUST be unique within the issuing system.

@root uid 1 … 1 R The 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:code CE 1 … 1 R (RESion)

@displayName st 1 … 1 R 'The employer of a person.', 'The school in which a person is enrolled.' or 'An organization with which a person is affiliated (e.g., a volunteer organization).'

@code cs 1 … 1 R EMPLOYER, SCHOOL or AFFILIATED

@codeSystemName st 1 … 1 F IHERoleCode

@codeSystem oid 1 … 1 F 1.3.6.1.4.1.19376.1.5.3.3

hl7:associatedPerson 0 … 1 Contact person at the employer, school or other affiliated (e.g., volunteer) organization.
Contains 2.16.756.5.30.1.1.10.9.34 Person Name Information Compilation - eCH-0011 (DYNAMIC) (RESion)

hl7:scopingOrganization 1 … 1 The employer, school or other affiliated (e.g., volunteer) organization.
Contains 2.16.756.5.30.1.1.10.9.27 Organization Compilation with name, addr, telecom (DYNAMIC) (RESion)

Schematron assert role error

test @code=EMPLOYER or @code=SCHOOL or @code=AFFILIATED

Message The code value shall indicate whether the participant is the employer, school or other affiliated (e.g., volunteer) organization.

Included 0 … * from 2.16.756.5.30.1.1.10.2.15 Insurance - participant (DYNAMIC)

hl7:participant 0 … * Information on a patient's insurance. (RESion)

@typeCode cs 1 … 1 F COV

hl7:templateId II 1 … 1 M (RESion)

@root uid 1 … 1 F 2.16.756.5.30.1.1.10.2.15

hl7:time IVL_TS.CH.TZ 0 … 1 Validity period of the contract. (RESion)

hl7:low TS.CH.TZ 1 … 1 R Start of the contract. (RESion)

hl7:high TS.CH.TZ 1 … 1 R End of the contract. (RESion)

hl7:associatedEntity 1 … 1 R (RESion)

@classCode cs 1 … 1 F PAYOR

hl7:id II 1 … 1 R The id of the contract ([ge]: Versichertennummer; [fr]: Numéro d'assuré). (RESion)

@extension st 1 … 1 R The id itself. It MUST be unique within the issuing system.

@root uid 1 … 1 R The 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:code CE 1 … 1 R The underlying law for the contract. (RESion)

@nullFlavor cs 0 … 1 F NAV

@displayName st 0 … 1 Federal Act on Health Insurance (HIA), Federal Act on Accident Insurance (AIA), Federal Act on Insurance Policies (Insurance Policies Act, IPA), Federal Act on Military Insurance (MilIA), Federal Act on Invalidity Insurance (InvIA)

@code cs 0 … 1 832.10, 832.20, 221.229.1, 833.1, 831.20

@codeSystemName st 0 … 1 F ins-laws

@codeSystem oid 0 … 1 F 2.16.756.5.30.2.1.1.11

Schematron assert role error

test (@nullFlavor='NAV' and not(@codeSystem or @codeSystemName or @code or @displayName)) or (@codeSystem='2.16.756.5.30.2.1.1.11' and @codeSystemName='ins-laws' and @code and @displayName)

Message Either a valid insurance law or nullFlavor="NAV" is REQUIRED.

hl7:associatedPerson 0 … 1 Contact person at the insurance company.
Contains 2.16.756.5.30.1.1.10.9.34 Person Name Information Compilation - eCH-0011 (DYNAMIC) (RESion)

hl7:scopingOrganization 1 … 1 The insurance company.
Contains 2.16.756.5.30.1.1.10.9.26 Organization Compilation with GLN, name, addr and telecom (DYNAMIC) (RESion)

where [hl7:id [@root='2.51.1.3']]

Included 0 … * from 2.16.756.5.30.1.1.10.2.14 Insurance Card - participant (DYNAMIC)

hl7:participant 0 … * Information on a patient's insurance card. (RESion)

@typeCode cs 1 … 1 F HLD

hl7:templateId II 1 … 1 M (RESion)

@root uid 1 … 1 F 2.16.756.5.30.1.127.10.2.14

hl7:time IVL_TS.CH.TZ 1 … 1 R Validity period of the insurance card. (RESion)

hl7:low TS.CH.TZ 1 … 1 (RESion)

@nullFlavor cs 1 … 1 F NASK

hl7:high TS.CH.TZ 1 … 1 R Expiration date of the insurance card. (RESion)

hl7:associatedEntity 1 … 1 R (RESion)

@classCode cs 1 … 1 F POLHOLD

hl7:id II 1 … 1 R The insurance card's id. (RESion)

@extension st 1 … 1 R Number of the insurance card.

cdachresp-dataelement-486

Nummer Versichertenkarte

@root uid 1 … 1 F 2.16.756.5.30.1.123.100.1.1.1

hl7:associatedPerson 0 … 1 Family and given name on the insurance card.
Contains 2.16.756.5.30.1.1.10.9.34 Person Name Information Compilation - eCH-0011 (DYNAMIC) (RESion)

hl7:scopingOrganization 0 … 1 The insurance company which issued the insurance card.
Contains 2.16.756.5.30.1.1.10.9.24 Organization Compilation with name (DYNAMIC) (RESion)

cdachresp-dataelement-525

Versicherung

Included 0 … * from 2.16.756.5.30.1.1.10.2.49 Invoice Recipient (DYNAMIC)

hl7:participant 0 … * Information on a invoice recipient. (RESion)

cdachresp-dataelement-560

Rechnungsadresse

@typeCode cs 1 … 1 F IND

hl7:templateId II 1 … 1 M (RESion)

@root uid 1 … 1 F 2.16.756.5.30.1.1.10.2.49

hl7:functionCode CE 0 … 1 (RESion)

CONF

The value of @code shall be drawn from value set 2.16.756.5.30.1.1.11.26 IVR valueset role (.143.11.21) (DYNAMIC)

hl7:associatedEntity ANY 1 … 1 R (RESion)

@classCode cs 1 … 1 F GUAR

hl7:addr AD 1 … 1 R Invoice to address
Contains 2.16.756.5.30.1.1.10.9.35 Address Information Compilation - eCH-0010 (DYNAMIC) (RESion)

cdachresp-dataelement-562

Postadresse (eCH-0010)

hl7:associatedPerson 0 … 1 person to invoice
Contains 2.16.756.5.30.1.1.10.9.34 Person Name Information Compilation - eCH-0011 (DYNAMIC) (RESion)

cdachresp-dataelement-563

nameData

hl7:scopingOrganization 0 … 1 If invoice recipient is a company
Contains 2.16.756.5.30.1.1.10.9.24 Organization Compilation with name (DYNAMIC) (RESion)

Included 0 … * from 2.16.756.5.30.1.1.10.2.43 Patient Contact - participant (DYNAMIC)

hl7:participant 0 … * Information on a patient contact. (RESion)

cdachresp-dataelement-359

Person / Organisation

@typeCode cs 1 … 1 F IND

hl7:templateId II 1 … 1 M (RESion)

@root uid 1 … 1 F 2.16.756.5.30.1.1.10.2.43

hl7:templateId II 1 … 1 M (RESion)

@root uid 1 … 1 F 1.3.6.1.4.1.19376.1.5.3.1.2.4

hl7:time IVL_TS.CH.TZ 0 … 1 Validity period of the participation. (RESion)

hl7:low TS.CH.TZ 1 … 1 R Start of participation. (RESion)

hl7:high TS.CH.TZ 1 … 1 R End of participation. (RESion)

hl7:associatedEntity 1 … 1 R Either the contact person or the contact's organization SHALL be present. (RESion)

@classCode cs 1 … 1 R The classCode attribute SHALL be present, and contains a value from the following set:
AGNT: agents of the patient
CAREGIVER: care givers
ECON: emergency contacts
NOK: next of kin
PRS: other relations

hl7:code CE 1 … 1 R The contact's role. (RESion)

@nullFlavor cs 0 … 1

@displayName st 0 … 1

@codeSystemName st 0 … 1 F HL7RoleCode

@codeSystem oid 0 … 1 F 2.16.840.1.113883.5.111

@code cs 0 … 1

cdachresp-dataelement-360

Rolle

Schematron assert role error

test (not(@nullFlavor) and @displayName and @code and @codeSystem and @codeSystemName) or (@nullFlavor and not(@displayName or @code or @codeSystem or @codeSystemName))

Message Either nullFlavor or a valid code is required.

hl7:addr AD 0 … * The contact's address.
Contains 2.16.756.5.30.1.1.10.9.35 Address Information Compilation - eCH-0010 (DYNAMIC) (RESion)

cdachresp-dataelement-364

Postadresse (eCH-0010)

hl7:telecom TEL 0 … * The contact's means of communication (phone, eMail, ...). (RESion)

hl7:associatedPerson 0 … 1 C The contact person.
Contains 2.16.756.5.30.1.1.10.9.34 Person Name Information Compilation - eCH-0011 (DYNAMIC) (RESion)

cdachresp-dataelement-361

Namen

hl7:scopingOrganization 0 … 1 C The contact's organization.
Contains 2.16.756.5.30.1.1.10.9.24 Organization Compilation with name (DYNAMIC) (RESion)

Schematron assert role error

test @classCode=('AGNT','CAREGIVER','ECON','NOK','PRS')

Message 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.

Included 0 … * from 2.16.756.5.30.1.1.10.2.16 Order Reference - inFulfillmentOf (DYNAMIC)

hl7:inFulfillmentOf 0 … * Reference to one or more orders which led to the creation of this CDA document. It SHALL be declared, when the order reference is relevant for some reason. (RESion)

hl7:templateId II 1 … 1 M (RESion)

@root uid 1 … 1 F 2.16.756.5.30.1.1.10.2.16

hl7:order 1 … 1 R (RESion)

hl7:id II 1 … * R Order number. (RESion)

@extension st 0 … 1 MUST be declared when @root is an OID and it MUST then contain the same value as the order itself (order id).

@root uid 1 … 1 R Either the same GUID (order id) or the same OID (order issuing system) as the order itself.

Included 0 … * from 2.16.756.5.30.1.1.10.2.46 Health Service - documentationOf (DYNAMIC)

hl7:documentationOf 0 … * Information about a health service describing the context of this CDA document. (RESion)

@typeCode cs 1 … 1 F DOC

hl7:templateId II 1 … 1 M (RESion)

@root uid 1 … 1 F 2.16.756.5.30.1.1.10.2.46

hl7:serviceEvent 1 … 1 R (RESion)

@classCode cs 1 … 1 F ACT

@moodCode cs 1 … 1 F EVN

hl7:id II 0 … * Health service identifiers such as case number ([ge]: Fallnummer; [fr]: Numéro de cas), consultation id, episode id, etc. (RESion)

@extension st 1 … 1 R The id itself. It MUST be unique within the issuing system.

@root uid 1 … 1 R The 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:code CE NP As long as the eventCodeList for the Swiss EPR metadata is not defined yet by the FDHA Ordinance on the Electronic Patient Record (EPRO-FDHA), the code element is not permitted in this template. It will be defined later. (RESion)

hl7:effectiveTime IVL_TS.CH.TZ 1 … 1 R Duration of the health service. (RESion)

hl7:low TS.CH.TZ 1 … 1 R Start of the health service. (RESion)

hl7:high TS.CH.TZ 1 … 1 R End of the health service. (RESion)

Included 0 … * from 2.16.756.5.30.1.1.10.9.31 Performer (DYNAMIC)

hl7:performer 0 … * Information about a healthcare provider who was the primary performer of the act. (RESion)

@typeCode cs 1 … 1 F PRF

hl7:templateId II 1 … 1 M (RESion)

@root uid 1 … 1 F 2.16.756.5.30.1.1.10.9.31

hl7:templateId 1 … 1 R (RESion)

@root uid 1 … 1 F 1.3.6.1.4.1.19376.1.5.3.1.1.24.3.5

@displayName st 1 … 1 R

@code cs 1 … 1 R

@codeSystemName st 1 … 1 F SNOMED CT

@codeSystem oid 1 … 1 F 2.16.840.1.113883.6.96

CONF

The value of @code shall be drawn from value set 2.16.756.5.30.1.127.3.10.1.1.3 EprAuthorRole (DYNAMIC)

Example <functionCode code="106292003" codeSystem="2.16.840.1.113883.6.96" codeSystemName="SNOMED CT" displayName="Professional nurse"/>

Example <functionCode code="133932002" codeSystem="2.16.840.1.113883.6.96" codeSystemName="SNOMED CT" displayName="Other Caregiver"> <originalText>Home helper</originalText></functionCode>

Schematron assert role error

test not(@code='133932002') or (originalText/text())

Message Other Caregivers description MUST be declared in the originalText element.

hl7:originalText ED 0 … 1 C Other Caregivers description MUST be declared in the originalText element. (RESion)

hl7:translation 0 … * A translation of the code to another coding system (e.g. ISCO-08: 2.16.840.1.113883.2.9.6.2.7) (RESion)

@displayName st 1 … 1 R

@code cs 1 … 1 R

@codeSystemName st 1 … 1 R

@codeSystem oid 1 … 1 R

hl7:time IVL_TS.CH.TZ 0 … 1 Duration of the performance. (RESion)

hl7:low TS.CH.TZ 1 … 1 R Start of the performance. (RESion)

hl7:high TS.CH.TZ 1 … 1 R End of the performance. (RESion)

hl7:assignedEntity 1 … 1 R Contains 2.16.756.5.30.1.1.10.9.32 Assigned Entity Compilation with id, name, addr, telecom, person and organization (DYNAMIC) (RESion)

Included 0 … * from 2.16.756.5.30.1.1.10.2.13 Document Replacement - relatedDocument (DYNAMIC)

hl7:relatedDocument

0 … *

Relationship to another CDA-CH V2 based document that is replaced by the current one.

Notes:
For correction of wrong information, a new document that replaces the earlier document MUST be created.
The new document corrects previously incorrect information. This also applies to the case where information in the CDA header has been corrected (e.g., if the original document has been issued to the wrong patient).
While processing the new document at the recipient, all values from the previous document MUST be interpreted as deprecated (deleted/marked as deleted/deprecated) and all values in the new document MUST be marked as valid:

Values that were only contained in the previous document have to be treated as deleted.
Values that are present in both documents are overwritten with the contents of the new document.
Values that are only contained in the new document are to be added.

(RES

ion)

@typeCode cs 1 … 1 F RPLC

Indicates that it is a relationship to another document that needs to be replaced.

hl7:parentDocument 1 … 1 R Relationship to the document that needs to be replaced. (RESion)

hl7:id II 1 … 1 M The id of the document to be replaced MUST be declared. (RESion)

@extension st 0 NP NP/not present

@root uid 1 … 1 R The id (GUID) of the document to be replaced.

hl7:setId II 1 … 1 M The setId of the document to be replaced MUST be declared. (RESion)

@extension st 0 NP NP/not present

@root uid 1 … 1 R The setId (GUID) of the document to be replaced and MUST be identical with the content of the setId of the current document.

Schematron assert role error

test (@root=/ClinicalDocument/id/@root) and not(@extension) and not(/ClinicalDocument/id/@extension)

Message ClinicalDocument/setId: MUST be identical to the one of the replaced document

hl7:versionNumber INT 1 … 1 M The version number of the document to be replaced. (RESion)

Schematron assert role error

test @value > /ClinicalDocument/versionNumber/@value

Message ClinicalDocument/versionNumber: MUST be higher than the one of the replaced document

Included 0 … * from 2.16.840.1.113883.10.12.114 CDA Authorization (DYNAMIC)

hl7:authorization 0 … * (RESion)

@typeCode 0 … 1 F AUTH

hl7:consent 1 … 1 (RESion)

@classCode 0 … 1 F CONS

@moodCode 0 … 1 F EVN

hl7:id II 0 … * (RESion)

hl7:code CE 0 … 1 (RESion)

@codeSystem CONF 0 … 1 F 2.16.840.1.113883.5.4 (Act Code)

hl7:statusCode CS 1 … 1 R (RESion)

@code CONF 0 … 1 F completed

Included 0 … 1 from 2.16.840.1.113883.10.12.113 CDA componentOf (DYNAMIC)

hl7:componentOf 0 … 1 (RESion)

@typeCode 0 … 1 F COMP

hl7:encompassingEncounter 1 … 1 (RESion)

@classCode 0 … 1 F ENC

@moodCode 0 … 1 F EVN

hl7:id II 0 … * (RESion)

hl7:code CE 0 … 1 (RESion)

CONF

The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.13955 ActEncounterCode (DYNAMIC)

hl7:effectiveTime IVL_TS 1 … 1 R (RESion)

hl7:dischargeDispositionCode CE 0 … 1 (RESion)

CONF

shall be drawn from concept domain "EncounterDischargeDisposition"

hl7:responsibleParty 0 … 1 Contains 2.16.840.1.113883.10.12.153 CDA AssignedEntity (DYNAMIC) (RESion)

@typeCode 0 … 1 F RESP

hl7:encounterParticipant 0 … * (RESion)

@typeCode cs 1 … 1 R

CONF

The value of @typeCode shall be drawn from value set 2.16.840.1.113883.1.11.19600 x_EncounterParticipant (DYNAMIC)

hl7:time IVL_TS 0 … 1 (RESion)

hl7:assignedEntity 1 … 1 Contains 2.16.840.1.113883.10.12.153 CDA AssignedEntity (DYNAMIC) (RESion)

hl7:location 0 … 1 (RESion)

@typeCode 0 … 1 F LOC

hl7:healthCareFacility 1 … 1 (RESion)

@classCode 0 … 1 F SDLOC

hl7:id II 0 … * (RESion)

hl7:code CE 0 … 1 (RESion)

CONF

The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.17660 ServiceDeliveryLocationRoleType (DYNAMIC)

hl7:location 0 … 1 Contains 2.16.840.1.113883.10.12.317 CDA Place (DYNAMIC) (RESion)

hl7:serviceProviderOrganization 0 … 1 Contains 2.16.840.1.113883.10.12.151 CDA Organization (DYNAMIC) (RESion)

Template RESP Header Template Compilation