hl7:ClinicalDocument
|
|
1 … 1 |
M |
Swiss eVACDOC - Immunization Certificate
Conformity rules that are not further modelled in ART-DECOR:
-
XML encoding
UTF-8 encoding is required. All CDA-CH V2 documents MUST start with this line:
<?xml version="1.0" encoding="UTF-8"?>
-
Phone numbers
Phone numbers MUST be declared in the international format.
Dots (.) MUST be used as separators for grouping of number blocks.
The minus sign (-) MUST be used as a separator between public and internal telephone
numbers. Purpose: Some telephone exchanges - especially in the US, allow direct dial-up
of an internal telephone number after the actual connection has been established over
the public telephone network.
Examples:
<telecom value="tel:+41.33.123.45.67"/>
<telecom value="tel:+1.987.654.3210-999"/>
|
(CDA -V2) |
| Included |
1 … 1 |
M |
from 2.16.756.5.30.1.1.10.2.25 Document Realm (DYNAMIC)
|
hl7:realmCode
|
CS |
1 … 1 |
M |
Swiss Realm (CHE) of HL7 CDA. |
CDA‑CH V2 |
@code
|
CONF |
1 … 1 |
F |
CHE |
hl7:typeId
|
II |
1 … 1 |
M |
HL7 CDA R2, 2005 |
(CDA-V2) |
@root
|
uid |
1 … 1 |
F |
2.16.840.1.113883.1.3 |
@extension
|
st |
1 … 1 |
F |
POCD_HD000040 |
| Included |
|
|
from 2.16.756.5.30.1.1.10.2.18 Document Template Ids CDA-CH v2.0 - structuredBody (DYNAMIC)
|
hl7:templateId
|
II |
0 … 1 |
|
CDA-CH v2.0 specification. This is an informational reference, only. |
CDA‑CH V2 |
@root
|
uid |
1 … 1 |
F |
2.16.756.5.30.1.1.1.1.4 |
hl7:templateId
|
II |
1 … 1 |
M |
HL7 CDA R2 (2005); contains ClinicalDocument.component as structuredBody. |
CDA‑CH V2 |
@root
|
uid |
1 … 1 |
F |
2.16.840.1.113883.10.12.2 |
hl7:templateId
|
II |
1 … 1 |
M |
HL7 CDA R2 (2005). |
CDA‑CH V2 |
@root
|
uid |
1 … 1 |
F |
2.16.840.1.113883.10.12.1 |
| Included |
|
|
from 2.16.756.5.30.1.1.10.2.67 Document Template Ids CDA-CH-VACD V2 for Swiss EPR (DYNAMIC)
|
hl7:templateId
|
II |
0 … 1 |
|
CDA-CH-VACD / eVACDOC V2 specification. This is an informational reference, only. |
CDA‑VACD |
@root
|
uid |
1 … 1 |
F |
2.16.756.5.30.1.1.1.1.3.5.2 |
hl7:templateId
|
II |
0 … 1 |
|
Exchange format according to the Swiss EPR. This templateId MUST be present, when
submitting a document to a XDS.b Registry/Repository according the Federal Act on
the Electronic Patient Record (EPRA). It MAY be omitted for other use cases.
|
CDA‑VACD |
@root
|
uid |
1 … 1 |
F |
2.16.756.5.30.1.127.1.4 |
| |
Schematron assert |
role |
 error
|
|
| |
test |
not(//hl7:id[@root=('2.16.756.5.31', '2.16.756.5.32')]) |
|
| |
Message |
The Swiss Social Security number is not allowed for the Swiss EPR. |
|
hl7:templateId
|
II |
1 … 1 |
M |
Immunization Content (IC) Content Module, IHE PCC Technical Framework Revision 11.0
- November 11, 2016.
|
CDA‑VACD |
@root
|
uid |
1 … 1 |
F |
1.3.6.1.4.1.19376.1.5.3.1.1.18.1.2 |
hl7:templateId
|
II |
1 … 1 |
M |
Medical Documents Specification, IHE PCC Technical Framework Revision 11.0 - November
11, 2016.
|
CDA‑VACD |
@root
|
uid |
1 … 1 |
F |
1.3.6.1.4.1.19376.1.5.3.1.1.1 |
hl7:templateId
|
II |
1 … 1 |
M |
CDA-CH-VACD / Immunization Certificate ART-DECOR model. |
(CDA-V2) |
@root
|
uid |
1 … 1 |
F |
2.16.756.5.30.1.1.10.1.15 |
| Included |
1 … 1 |
M |
from 2.16.756.5.30.1.1.10.2.63 Document Code (DYNAMIC)
|
hl7:code
|
CE |
1 … 1 |
M |
A LOINC based document type of a CDA document instance including a translation to
the Swiss EPR XDS.b metadata.
The LOINC code of the document MUST read according to IHE PCC TF2, Rev.11: 11369-6
(HISTORY OF IMMUNIZATIONS)
|
IHE PCC TF2 Rev.11, 6.3.1.10.1 |
@code
|
cs |
1 … 1 |
F |
11369-6 |
@codeSystem
|
oid |
1 … 1 |
F |
2.16.840.1.113883.6.1 |
@codeSystemName
|
st |
1 … 1 |
F |
LOINC |
@displayName
|
st |
1 … 1 |
F |
HISTORY OF IMMUNIZATIONS |
hl7:translation
|
CD |
1 … 1 |
M |
The translation to the Swiss EPR XDS.b metadata. |
IHE PCC TF2 Rev.11, 6.3.1.10.1 |
@code
|
cs |
1 … 1 |
F |
41000179103 |
@codeSystem
|
oid |
1 … 1 |
F |
2.16.840.1.113883.6.96 |
@codeSystemName
|
st |
1 … 1 |
F |
SNOMED CT |
@displayName
|
st |
1 … 1 |
F |
Immunization record |
| |
CONF |
|
hl7:title
|
ST |
1 … 1 |
M |
The document title MUST read:
- [de]: 'Impfausweis'
- [fr]: 'Carnet de vaccination'
- [it]: 'Certificato di vaccinazione'
- [en]: 'Immunization Certificate'
|
(CDA-V2) |
| |
Variable let |
Name |
languageCode |
|
| |
Value |
substring(/hl7:ClinicalDocument/hl7:languageCode/@code,1,2) |
|
| |
Schematron assert |
role |
error
|
|
| |
test |
not($languageCode='en') or starts-with(text(),'Immunization Certificate') |
|
| |
Message |
The English title MUST read 'Immunization Certificate' |
|
| |
Schematron assert |
role |
error
|
|
| |
test |
not($languageCode='de') or starts-with(text(),'Impfausweis') |
|
| |
Message |
The German title MUST read 'Impfausweis' |
|
| |
Schematron assert |
role |
error
|
|
| |
test |
not($languageCode='fr') or starts-with(text(),'Carnet de vaccination') |
|
| |
Message |
The French title MUST read 'Carnet de vaccination' |
|
| |
Schematron assert |
role |
error
|
|
| |
test |
not($languageCode='it') or starts-with(text(),'Certificato di vaccinazione') |
|
| |
Message |
The Italian title MUST read 'Certificato di vaccinazione' |
|
hl7:effectiveTime
|
TS.CH.TZ |
1 … 1 |
M |
ClinicalDocument/effectiveTime MUST exist. It contains the creation date and time
of the laboratory report. If this document replaces a previous version (linked via
parentDocument), this is the date and time of the new version.
|
(CDA-V2) |
| 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. |
CDA‑CH V2 |
@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 |
|
| 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.
|
CDA‑CH V2 |
| |
CONF |
|
| Included |
1 … 1 |
M |
from 2.16.756.5.30.1.1.10.2.20 Document Set Id and Version Number (DYNAMIC)
|
hl7:setId
|
II |
1 … 1 |
M |
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.
|
CDA‑CH V2 |
@root
|
uid |
1 … 1 |
R |
The root attribute MUST contain the setId as Globally Unique Identifier (GUID). |
@extension
|
st |
0 |
NP |
NP/not present |
| |
Schematron assert |
role |
error
|
|
| |
test |
(parent::*/hl7:versionNumber[@value='1'] and @root=parent::*/hl7:id/@root and (@extension=parent::*/hl7:id/@extension
or (not(@extension) and not(parent::*/hl7:id/@extension)))) or (parent::*/hl7:versionNumber[not(@value
='1')] and ((@root=parent::*/hl7:id/@root and @extension and not(@extension=parent::*/hl7:id/@extension))
or(not(@root=parent::*/hl7:id/@root))))
|
|
| |
Message |
The setId MUST be equal with the document id for version 1 and it MUST differ for
all other versions. |
|
hl7:versionNumber
|
INT.NONNEG |
1 … 1 |
M |
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.
|
CDA‑CH V2 |
| Included |
1 … 1 |
M |
from 2.16.756.5.30.1.1.10.2.68 Human Patient - recordTarget (DYNAMIC)
|
hl7:recordTarget
|
|
1 … 1 |
M |
A human patient for whom this CDA document instance was created. |
CDA‑VACD |
hl7:templateId
|
II |
1 … 1 |
M |
|
CDA‑VACD |
@root
|
uid |
1 … 1 |
F |
2.16.756.5.30.1.1.10.2.68 |
hl7:templateId
|
II |
1 … 1 |
M |
|
CDA‑VACD |
@root
|
uid |
1 … 1 |
F |
2.16.756.5.30.1.1.10.2.1 |
hl7:patientRole
|
|
1 … 1 |
R |
|
CDA‑VACD |
hl7:id
|
II |
1 … * |
R |
The patient's id. |
CDA‑VACD |
@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.
|
@extension
|
st |
0 … 1 |
|
Contains the ID itself. The ID MUST be unique within the system that issued the ID. |
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)
|
CDA‑VACD |
hl7:telecom
|
TEL |
0 … * |
|
The patient's means of communication (phone, eMail, ...). |
CDA‑VACD |
hl7:patient
|
|
1 … 1 |
R |
Contains 2.16.756.5.30.1.1.10.9.34 Person Name Information Compilation - eCH-0011 (DYNAMIC)
|
CDA‑VACD |
 |
|
|
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 |
M |
The patient's gender according to the Swiss EPR XDS.b metadata. |
CDA‑VACD |
@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 |
|
hl7:birthTime
|
TS.CH.TZ |
1 … 1 |
M |
The patient's birthdate. |
CDA‑VACD |
hl7:maritalStatusCode
|
CE |
0 … 1 |
|
The patient's marital status. |
CDA‑VACD |
@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 |
|
hl7:translation
|
|
0 … * |
|
A translation of the code to another coding system |
CDA‑VACD |
@code
|
cs |
1 … 1 |
R |
|
@codeSystem
|
oid |
1 … 1 |
R |
|
@codeSystemName
|
st |
1 … 1 |
R |
|
@displayName
|
st |
1 … 1 |
R |
|
hl7:religiousAffiliationCode
|
CE |
0 … 1 |
|
The patient's religion. |
CDA‑VACD |
@nullFlavor
|
cs |
0 … 1 |
F |
NAV |
@code
|
cs |
0 … 1 |
|
|
@codeSystem
|
oid |
0 … 1 |
|
|
@codeSystemName
|
st |
0 … 1 |
|
|
@displayName
|
st |
0 … 1 |
|
|
| |
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. |
CDA‑VACD |
hl7:id
|
II |
0 … * |
|
The guardian's id. |
CDA‑VACD |
@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.
|
@extension
|
st |
0 … 1 |
|
Contains the ID itself. The ID MUST be unique within the system that issued the ID. |
hl7:code
|
CE |
0 … 1 |
|
The guardian's role. |
CDA‑VACD |
@nullFlavor
|
cs |
0 … 1 |
|
|
@code
|
cs |
0 … 1 |
|
|
@codeSystem
|
oid |
0 … 1 |
F |
2.16.840.1.113883.5.111 |
@codeSystemName
|
st |
0 … 1 |
F |
HL7RoleCode |
@displayName
|
st |
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)
|
CDA‑VACD |
hl7:telecom
|
TEL |
0 … * |
|
The guardian's means of communication (phone, eMail, ...). |
CDA‑VACD |
| Choice |
1 … 1 |
|
Elements 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‑VACD |
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‑VACD |
hl7:birthplace
|
|
0 … 1 |
|
The patient's birthplace. |
CDA‑VACD |
hl7:place
|
|
1 … 1 |
|
|
CDA‑VACD |
hl7:name
|
EN |
0 … 1 |
|
The patient's birthplace name. |
CDA‑VACD |
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)
|
CDA‑VACD |
hl7:languageCommunication
|
|
0 … * |
|
The patient's language skills. |
CDA‑VACD |
hl7:languageCode
|
CS |
1 … 1 |
|
|
CDA‑VACD |
| |
CONF |
|
hl7:modeCode
|
CE |
0 … 1 |
|
|
CDA‑VACD |
| |
CONF |
|
hl7:proficiencyLevelCode
|
CE |
0 … 1 |
|
|
CDA‑VACD |
| |
CONF |
|
hl7:preferenceInd
|
BL |
0 … 1 |
|
In case of @value=true it is the patient's correspondence language. |
CDA‑VACD |
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)
|
CDA‑VACD |
|
|
|
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.
|
CDA‑CH V2 |
hl7:templateId
|
II |
1 … 1 |
M |
|
CDA‑CH V2 |
@root
|
uid |
1 … 1 |
F |
2.16.756.5.30.1.1.10.9.23 |
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, nullFlavor='NAV' MUST be used. In this case, the originalText element MUST
contain the description of the role.
Translations to other vocabularies are allowed.
|
CDA‑CH V2 |
@nullFlavor
|
st |
0 … 1 |
F |
NAV |
@code
|
cs |
0 … 1 |
|
|
@codeSystem
|
oid |
0 … 1 |
F |
2.16.840.1.113883.6.96 |
@codeSystemName
|
st |
0 … 1 |
F |
SNOMED CT |
@displayName
|
st |
0 … 1 |
|
|
| |
CONF |
|
| |
Example |
Patient <functionCode code="116154003" codeSystem="2.16.840.1.113883.6.96" codeSystemName="SNOMED CT" displayName="Patient"/> |
| |
Example |
Nurse <functionCode code="106292003" codeSystem="2.16.840.1.113883.6.96" codeSystemName="SNOMED CT" displayName="Professional nurse"/> |
| |
Example |
Home helper <functionCode nullFlavor="NAV">
<originalText>Home helper</originalText></functionCode> |
| |
Example |
Laboratory technician <functionCode nullFlavor="NAV">
<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 |
(@code and @codeSystem) or (@nullFlavor='NAV') |
|
| |
Message |
Either a code with its code system or nullFlavor='NAV' is required. |
|
| |
Schematron assert |
role |
error
|
|
| |
test |
not(@nullFlavor) or (hl7:originalText) |
|
| |
Message |
Other Caregivers description MUST be declared in the originalText element in case
of nullFlavor. |
|
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) |
CDA‑CH V2 |
@code
|
cs |
1 … 1 |
R |
|
@codeSystem
|
oid |
1 … 1 |
R |
|
@codeSystemName
|
st |
1 … 1 |
R |
|
@displayName
|
st |
1 … 1 |
R |
|
hl7:time
|
TS.CH.TZ |
1 … 1 |
R |
Timestamp of the authorship. |
CDA‑CH V2 |
hl7:assignedAuthor
|
|
1 … 1 |
R |
|
CDA‑CH V2 |
| |
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.
|
CDA‑CH V2 |
@nullFlavor
|
cs |
0 … 1 |
F |
NAV |
| |
Temporarily unknown, will be filled later. |
@root
|
cs |
0 … 1 |
F |
2.51.1.3 |
| |
OID for GS1 GLN. |
@extension
|
st |
0 … 1 |
|
The 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. |
CDA‑CH V2 |
@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.
|
@extension
|
st |
0 … 1 |
|
Contains the ID itself. The ID MUST be unique within the system that issued the ID. |
hl7:addr
|
AD |
0 … * |
|
The author's address.
Contains 2.16.756.5.30.1.1.10.9.35 Address Information Compilation - eCH-0010 (DYNAMIC)
|
CDA‑CH V2 |
hl7:telecom
|
TEL |
0 … * |
|
The author's means of communication (phone, eMail, ...). |
CDA‑CH V2 |
| Choice |
1 … 1 |
|
Elements to choose from:
|
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)
|
CDA‑CH V2 |
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)
|
CDA‑CH V2 |
hl7:representedOrganization
|
|
0 … 1 |
|
The author's organization.
Contains 2.16.756.5.30.1.1.10.9.24 Organization Compilation with name (DYNAMIC)
|
CDA‑CH V2 |
| 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.
|
CDA‑CH V2 |
hl7:templateId
|
II |
1 … 1 |
M |
|
CDA‑CH V2 |
@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. |
CDA‑CH V2 |
hl7:assignedEntity
|
|
1 … 1 |
R |
Contains 2.16.756.5.30.1.1.10.9.12 Assigned Entity Compilation with id (DYNAMIC)
|
CDA‑CH V2 |
| Included |
1 … 1 |
M |
from 2.16.756.5.30.1.1.10.2.3 Custodian (DYNAMIC)
|
hl7:custodian
|
|
1 … 1 |
M |
The organization in whose name this CDA document has been created (corresponds to
the sender of a letter).
|
CDA‑CH V2 |
hl7:templateId
|
II |
1 … 1 |
M |
|
CDA‑CH V2 |
@root
|
uid |
1 … 1 |
F |
2.16.756.5.30.1.1.10.2.3 |
hl7:assignedCustodian
|
|
1 … 1 |
R |
|
CDA‑CH V2 |
hl7:representedCustodianOrganization
|
|
1 … 1 |
R |
|
CDA‑CH V2 |
hl7:id
|
II |
1 … * |
M |
The custodian's id. |
CDA‑CH V2 |
@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.
|
@extension
|
st |
0 … 1 |
|
Contains the ID itself. The ID MUST be unique within the system that issued the ID. |
hl7:name
|
ON |
1 … 1 |
R |
The custodian's name. |
CDA‑CH V2 |
hl7:telecom
|
TEL |
0 … * |
|
The custodian's means of communication (phone, eMail, ...). |
CDA‑CH V2 |
hl7:addr
|
AD |
0 … * |
|
The custodian's address(es).
Contains 2.16.756.5.30.1.1.10.9.35 Address Information Compilation - eCH-0010 (DYNAMIC)
|
CDA‑CH V2 |
| Included |
1 … * |
M |
from 2.16.756.5.30.1.1.10.2.4 Recipient - informationRecipient (DYNAMIC)
|
hl7:informationRecipient
|
|
1 … * |
M |
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).
|
CDA‑CH V2 |
@typeCode
|
cs |
0 … 1 |
|
The main recipient of the document is indicated by typeCode 'PRCP' (primary recipient).
This is the default value used when the attribute is not present.
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 |
|
hl7:templateId
|
II |
1 … 1 |
M |
|
CDA‑CH V2 |
@root
|
uid |
1 … 1 |
F |
2.16.756.5.30.1.1.10.2.4 |
hl7:intendedRecipient
|
|
1 … 1 |
R |
|
CDA‑CH V2 |
hl7:id
|
II |
0 … * |
R |
The recipient's identification(s). |
CDA‑CH V2 |
@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.
|
@extension
|
st |
0 … 1 |
|
Contains the ID itself. The ID MUST be unique within the system that issued the ID. |
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)
|
CDA‑CH V2 |
hl7:telecom
|
TEL |
0 … * |
|
The recipient's means of communication (phone, eMail, ...). |
CDA‑CH V2 |
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)
|
CDA‑CH V2 |
hl7:receivedOrganization
|
|
0 … 1 |
|
The addressee organization.
Contains 2.16.756.5.30.1.1.10.9.24 Organization Compilation with name (DYNAMIC)
|
CDA‑CH V2 |
| 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.
|
CDA‑CH V2 |
hl7:templateId
|
II |
1 … 1 |
M |
|
CDA‑CH V2 |
@root
|
uid |
1 … 1 |
F |
2.16.756.5.30.1.1.10.2.5 |
hl7:time
|
TS.CH.TZ |
1 … 1 |
R |
Timestamp of the signature. |
CDA‑CH V2 |
hl7:signatureCode
|
CS |
1 … 1 |
R |
|
CDA‑CH V2 |
@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 |
|
hl7:assignedEntity
|
|
1 … 1 |
R |
Contains 2.16.756.5.30.1.1.10.9.12 Assigned Entity Compilation with id (DYNAMIC)
|
CDA‑CH V2 |
| Included |
0 … 1 |
|
from 2.16.756.5.30.1.1.10.2.6 Authenticator (DYNAMIC)
|
hl7:authenticator
|
|
0 … 1 |
|
Information about an authenticator of a CDA document. An authenticator MUST be a person. |
CDA‑CH V2 |
hl7:templateId
|
II |
1 … 1 |
M |
|
CDA‑CH V2 |
@root
|
uid |
1 … 1 |
F |
2.16.756.5.30.1.1.10.2.6 |
hl7:time
|
TS.CH.TZ |
1 … 1 |
R |
Timestamp of the signature. |
CDA‑CH V2 |
hl7:signatureCode
|
CS |
1 … 1 |
R |
|
CDA‑CH V2 |
@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 |
|
hl7:assignedEntity
|
|
1 … 1 |
R |
Contains 2.16.756.5.30.1.1.10.9.12 Assigned Entity Compilation with id (DYNAMIC)
|
CDA‑CH V2 |
| Included |
0 … 1 |
|
from 2.16.756.5.30.1.1.10.2.16 Order Reference - inFulfillmentOf (DYNAMIC)
|
hl7:inFulfillmentOf
|
|
0 … 1 |
|
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.
|
CDA‑CH V2 |
hl7:templateId
|
II |
1 … 1 |
M |
|
CDA‑CH V2 |
@root
|
uid |
1 … 1 |
F |
2.16.756.5.30.1.1.10.2.16 |
hl7:order
|
|
1 … 1 |
R |
|
CDA‑CH V2 |
hl7:id
|
II |
1 … * |
R |
Order number. |
CDA‑CH V2 |
@root
|
uid |
1 … 1 |
R |
Either the same GUID (order id) or the same OID (order issuing system) as the order
itself.
|
@extension
|
st |
0 … 1 |
|
Contains the order ID itself. The ID MUST be unique within the system that issued
the ID.
|
| Included |
0 … 1 |
|
from 2.16.756.5.30.1.1.10.2.46 Health Service - documentationOf (DYNAMIC)
|
hl7:documentationOf
|
|
0 … 1 |
|
Information about a health service describing the context of this CDA document. |
CDA‑CH V2 |
@typeCode
|
cs |
1 … 1 |
F |
DOC |
hl7:templateId
|
II |
1 … 1 |
M |
|
CDA‑CH V2 |
@root
|
uid |
1 … 1 |
F |
2.16.756.5.30.1.1.10.2.46 |
hl7:serviceEvent
|
|
1 … 1 |
R |
|
CDA‑CH V2 |
@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.
|
CDA‑CH V2 |
@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.
|
@extension
|
st |
0 … 1 |
|
The id itself. It MUST be unique within the issuing system. |
hl7:code
|
CE |
1 … 1 |
R |
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 nullFlavor='NAV'
MUST be used in this template. Other codes MAY be declared as translation.
|
CDA‑CH V2 |
@nullFlavor
|
st |
1 … 1 |
F |
NAV |
@code
|
cs |
0 |
NP |
NP/not present |
@codeSystem
|
oid |
0 |
NP |
NP/not present |
@codeSystemName
|
st |
0 |
NP |
NP/not present |
@displayName
|
st |
0 |
NP |
NP/not present |
hl7:translation
|
|
0 … * |
|
A translation of the code to another coding system. |
CDA‑CH V2 |
@code
|
cs |
1 … 1 |
R |
|
@codeSystem
|
oid |
1 … 1 |
R |
|
@codeSystemName
|
st |
1 … 1 |
R |
|
@displayName
|
st |
1 … 1 |
R |
|
hl7:effectiveTime
|
IVL_TS.CH.TZ |
1 … 1 |
R |
Duration of the health service. |
CDA‑CH V2 |
hl7:low
|
TS.CH.TZ |
1 … 1 |
R |
Start of the health service. |
CDA‑CH V2 |
hl7:high
|
TS.CH.TZ |
1 … 1 |
R |
End of the health service. |
CDA‑CH V2 |
| 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. |
CDA‑CH V2 |
@typeCode
|
cs |
1 … 1 |
F |
PRF |
hl7:templateId
|
II |
1 … 1 |
M |
|
CDA‑CH V2 |
@root
|
uid |
1 … 1 |
F |
2.16.756.5.30.1.1.10.9.31 |
hl7:templateId
|
|
1 … 1 |
R |
|
CDA‑CH V2 |
@root
|
uid |
1 … 1 |
F |
1.3.6.1.4.1.19376.1.5.3.1.1.24.3.5 |
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.
|
CDA‑CH V2 |
@code
|
cs |
1 … 1 |
R |
|
@codeSystem
|
oid |
1 … 1 |
F |
2.16.840.1.113883.6.96 |
@codeSystemName
|
st |
1 … 1 |
F |
SNOMED CT |
@displayName
|
st |
1 … 1 |
R |
|
| |
CONF |
|
| |
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 (hl7:originalText/text()) |
|
| |
Message |
Other Caregivers description MUST be declared in the originalText element. |
|
| Included |
0 … 1 |
C |
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
|
ED |
0 … 1 |
C |
|
CDA‑CH V2 |
hl7:reference
|
TEL |
1 … 1 |
M |
The 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 … 1 |
R |
Reference to the narrative part of the section in the format '#xxx', where xxx is
the ID of the corresponding
element.
|
| |
Schematron assert |
role |
error
|
|
| |
test |
starts-with(@value,'#') |
|
| |
Message |
The @value attribute content MUST conform to the format '#xxx', where xxx is the ID
of the corresponding <content/> element. |
|
| |
Variable let |
Name |
idvalue |
|
| |
Value |
substring-after(@value,'#') |
|
| |
Schematron assert |
role |
error
|
|
| |
test |
ancestor::hl7:structuredBody//*[@ID=$idvalue] |
|
| |
Message |
No narrative text found for this reference (no content element within this document
has an ID that corresponds to '<value-of select="$idvalue"/>'). |
|
| |
Schematron assert |
role |
error
|
|
| |
test |
parent::*/text()=ancestor::hl7:structuredBody//*[@ID=$idvalue]/text() |
|
| |
Message |
The originalText content MUST be identical to the narrative text for this reference. |
|
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) |
CDA‑CH V2 |
@code
|
cs |
1 … 1 |
R |
|
@codeSystem
|
oid |
1 … 1 |
R |
|
@codeSystemName
|
st |
1 … 1 |
R |
|
@displayName
|
st |
1 … 1 |
R |
|
hl7:time
|
IVL_TS.CH.TZ |
0 … 1 |
|
Duration of the performance. |
CDA‑CH V2 |
hl7:low
|
TS.CH.TZ |
1 … 1 |
R |
Start of the performance. |
CDA‑CH V2 |
hl7:high
|
TS.CH.TZ |
1 … 1 |
R |
End of the performance. |
CDA‑CH V2 |
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)
|
CDA‑CH V2 |
| 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. |
CDA‑CH V2 |
@typeCode
|
cs |
1 … 1 |
F |
HLD |
hl7:templateId
|
II |
1 … 1 |
M |
|
CDA‑CH V2 |
@root
|
uid |
1 … 1 |
F |
2.16.756.5.30.1.1.10.2.14 |
hl7:time
|
IVL_TS.CH.TZ |
1 … 1 |
R |
Validity period of the insurance card. |
CDA‑CH V2 |
hl7:low
|
TS.CH.TZ |
1 … 1 |
|
|
CDA‑CH V2 |
@nullFlavor
|
cs |
1 … 1 |
F |
NASK |
hl7:high
|
TS.CH.TZ |
1 … 1 |
R |
Expiration date of the insurance card. |
CDA‑CH V2 |
hl7:associatedEntity
|
|
1 … 1 |
R |
|
CDA‑CH V2 |
@classCode
|
cs |
1 … 1 |
F |
POLHOLD |
hl7:id
|
II |
1 … 1 |
R |
The insurance card's id. |
CDA‑CH V2 |
@root
|
uid |
1 … 1 |
F |
2.16.756.5.30.1.123.100.1.1.1 |
@extension
|
st |
1 … 1 |
R |
Number of the insurance card. |
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)
|
CDA‑CH V2 |
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)
|
CDA‑CH V2 |
| 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. |
CDA‑CH V2 |
@typeCode
|
cs |
1 … 1 |
F |
COV |
hl7:templateId
|
II |
1 … 1 |
M |
|
CDA‑CH V2 |
@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. |
CDA‑CH V2 |
hl7:low
|
TS.CH.TZ |
1 … 1 |
R |
Start of the contract. |
CDA‑CH V2 |
hl7:high
|
TS.CH.TZ |
1 … 1 |
R |
End of the contract. |
CDA‑CH V2 |
hl7:associatedEntity
|
|
1 … 1 |
R |
|
CDA‑CH V2 |
@classCode
|
cs |
1 … 1 |
F |
PAYOR |
hl7:id
|
II |
1 … 1 |
R |
The id of the contract ([ge]: Versichertennummer; [fr]: Numéro d'assuré). |
CDA‑CH V2 |
@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.
|
@extension
|
st |
0 … 1 |
|
The id itself. It MUST be unique within the issuing system. |
hl7:code
|
CE |
1 … 1 |
R |
The underlying law for the contract. |
CDA‑CH V2 |
@nullFlavor
|
cs |
0 … 1 |
F |
NAV |
@code
|
cs |
0 … 1 |
|
832.10, 832.20, 221.229.1, 833.1, 831.20 |
@codeSystem
|
oid |
0 … 1 |
F |
2.16.756.5.30.2.1.1.11 |
@codeSystemName
|
st |
0 … 1 |
F |
ins-laws |
@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)
|
| |
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)
|
CDA‑CH V2 |
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)
|
CDA‑CH V2 |
|
|
|
where [hl7:id [@root='2.51.1.3']] |
|
|
| 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.
|
CDA‑CH V2 |
@typeCode
|
cs |
1 … 1 |
F |
RPLC |
| |
Indicates that it is a relationship to another document that needs to be replaced. |
hl7:templateId
|
II |
1 … 1 |
M |
|
CDA‑CH V2 |
@root
|
uid |
1 … 1 |
F |
2.16.756.5.30.1.1.10.2.13 |
hl7:parentDocument
|
|
1 … 1 |
R |
Relationship to the document that needs to be replaced. |
CDA‑CH V2 |
hl7:id
|
II |
1 … 1 |
M |
The id of the document to be replaced MUST be declared. |
CDA‑CH V2 |
@root
|
uid |
1 … 1 |
R |
The id (GUID) of the document to be replaced. |
@extension
|
st |
0 |
NP |
NP/not present |
hl7:setId
|
II |
1 … 1 |
M |
The setId of the document to be replaced MUST be declared. |
CDA‑CH V2 |
@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=/hl7:ClinicalDocument/hl7:id/@root) and not(@extension) and not(/hl7:ClinicalDocument/hl7: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. |
CDA‑CH V2 |
| |
Schematron assert |
role |
error
|
|
| |
test |
@value > /hl7:ClinicalDocument/hl7:versionNumber/@value |
|
| |
Message |
ClinicalDocument/versionNumber: MUST be higher than the one of the replaced document |
|
hl7:component
|
|
1 … 1 |
R |
|
(CDA-V2) |
hl7:structuredBody
|
|
1 … 1 |
R |
|
(CDA-V2) |
hl7:component
|
|
1 … 1 |
R |
Contains 2.16.756.5.30.1.1.10.3.47 Immunizations Section - coded (DYNAMIC)
|
(CDA-V2) |
|
|
|
where [hl7:section [hl7:templateId [@root='2.16.756.5.30.1.1.10.3.47'] and hl7:templateId
[@root='2.16.840.1.113883.10.20.1.6'] and hl7:templateId [@root='1.3.6.1.4.1.19376.1.5.3.1.3.23']]] |
|
|
| |
Schematron assert |
role |
 warning
|
|
| |
test |
not(//hl7:id[@root='2.16.756.5.30.1.127.3.10.3']) |
|
| |
Message |
This CDA-CH V2 document contains a Swiss EPR-SPID. Please make sure, that this fits
the legal base. |
|
| |
Schematron report |
role |
warning
|
|
| |
test |
//hl7:id[@root=('2.16.756.5.31', '2.16.756.5.32')]/parent::hl7:patientRole |
|
| |
Message |
This CDA-CH V2 document contains a Swiss Social Security number as patient identifier.
Please make sure, that this fits the legal base. |
|
| |
Schematron assert |
role |
error
|
|
| |
test |
not(//hl7:id[@root=('2.16.756.5.30.1.127.3.10.3', '2.16.756.5.31', '2.16.756.5.32')]/../..[not(hl7:patientRole)]) |
|
| |
Message |
Swiss EPR-SPID and Social Security numbers are not allowed in CDA-CH V2 documents
for other objects than the patient. |
|
Template Immunization Certificate
Document Realm (2017)