Template

Show index

Template SCDO Author 2018‑06‑26 18:00:12

Id2.16.756.5.30.1.1.10.9.52Effective Date2018‑06‑26 18:00:12
Statusdraft DraftVersion Label2017
Namescdo_cdach_other_AuthorDisplay NameSCDO Author
Description
Information about the author of a CDA document, section or entry. An author MAY be a person or a device. All CDA-CH V2 derivatives, i.e. Swiss exchange formats MUST use this template at least in the CDA Header by either reference or specialisation.
ContextParent nodes of template element with id 2.16.756.5.30.1.1.10.9.52
LabelCDA‑CH V2
ClassificationTemplate type not specified
Open/ClosedOpen (other than defined elements are allowed)
Used by / Uses
Used by 0 transactions and 1 template, Uses 3 templates
Used by as NameVersion
2.16.756.5.30.1.1.10.1.20Includedraft CDA-CH - Scanned document (2017)2018‑06‑08 13:36:50
Uses as NameVersion
2.16.756.5.30.1.1.10.9.21Containmentactive Device Compilation with name (2017)DYNAMIC
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.35Containmentdraft Address Information Compilation - eCH-0010 (2022)DYNAMIC
RelationshipSpecialization: template 2.16.756.5.30.1.1.10.9.23 Author (2018‑04‑18)
ref
hl7chcda-

Specialization: template 2.16.840.1.113883.10.12.102 CDA author (2005‑09‑07)
ref
ad1bbr-
Example
Sample author
<author>
  <templateId root="2.16.756.5.30.1.1.10.9.23"/>  <functionCode code="309343006" codeSystem="2.16.840.1.113883.6.96" codeSystemName="SNOMED CT" displayName="Physician"/>  <time value="20170905"/>  <assignedAuthor>
    <id root="2.51.1.3" extension="7608888888888"/>    <assignedPerson>
      <name>
        <prefix>Dr. med.</prefix>        <given>Allzeit</given>        <family>Bereit</family>      </name>
    </assignedPerson>
    <representedOrganization>
      <id root="2.51.1.3" extension="7609999999999"/>      <name>Gruppenpraxis CH</name>      <telecom value="tel:+41.32.234.55.66" use="WP"/>      <telecom value="fax:+41.32.234.55.67" use="WP"/>      <telecom value="mailto:bereit@gruppenpraxis.ch" use="WP"/>      <telecom value="http:www.gruppenpraxis.ch" use="WP"/>      <addr use="WP">
        <streetName>Doktorgasse</streetName>        <houseNumber>2</houseNumber>        <city>Musterhausen</city>        <postalCode>8888</postalCode>        <country>CH</country>      </addr>
    </representedOrganization>
  </assignedAuthor>
</author>
ItemDTCardConfDescriptionLabel
hl7:author
1 … *RInformation about the author of a CDA document, section or entry. An author MAY be a person or a device.CDA‑CH V2
hl7:templateId
II1 … 1MCDA‑CH V2
@root
uid1 … 1F2.16.756.5.30.1.1.10.9.23
hl7:templateId
II1 … 1MCDA‑CH V2
@root
uid1 … 1F2.16.756.5.30.1.1.10.9.52
hl7:functionCode
CE1 … 1R

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
st0 … 1FNAV
@code
cs0 … 1 
@codeSystem
oid0 … 1F2.16.840.1.113883.6.96
@codeSystemName
st0 … 1FSNOMED CT
@displayName
st0 … 1 
 CONF
The value of @code shall be drawn from value set 2.16.756.5.30.1.127.3.10.1.1.3 DocumentEntry.author.authorRole (DYNAMIC)
 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 assertrolered error 
 test(@code and @codeSystem) or (@nullFlavor='NAV') 
 MessageEither a code with its code system or nullFlavor='NAV' is required. 
 Schematron assertrolered error 
 testnot(@nullFlavor) or (hl7:originalText) 
 MessageOther 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
cs1 … 1R
@codeSystem
oid1 … 1R
@codeSystemName
st1 … 1R
@displayName
st1 … 1R
hl7:time
TS.CH.TZ1 … 1RTimestamp of the authorship.CDA‑CH V2
 Schematron assertroleyellow hint 
 test@value=parent::node()/parent::node()/hl7:effectiveTime/@value 
 MessageThis value shall be equal to that of ClinicalDocument/effectiveTime 
 Schematron assertrolered error 
 teststring-length(@value)<10 or ( string-length(@value)>=10 and (contains(@value,'+') or contains(@value,'-'))) 
 MessageThe time shall include the time zone offset from GMT 
 Schematron assertrolered error 
 teststring-length(@value) >= 8 
 MessageAt a minimum, the time shall be precise to the day 
hl7:assignedAuthor
1 … 1RCDA‑CH V2
 Schematron assertrolered error 
 testnot(assignedAuthoringDevice/softwareName) or (representedOrganization) 
 MessageFor device authors the element representedOrganization is REQUIRED. 
hl7:id
II1 … 1R 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
cs0 … 1FNAV
 Temporarily unknown, will be filled later.
@root
cs0 … 1F2.51.1.3
 OID for GS1 GLN.
@extension
st0 … 1 The GS1 GLN.
 Schematron assertrolered error 
 test(@root='2.51.1.3' and @extension) or (@nullFlavor='NAV') 
 MessageEither the GS1 GLN or nullFlavor='NAV' is REQUIRED 
hl7:id
II0 … *Other ids are allowed.CDA‑CH V2
@root
cs1 … 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 Contains the ID itself. The ID MUST be unique within the system that issued the ID.
hl7:addr
AD0 … *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
TEL0 … *The author's means of communication (phone, eMail, ...).CDA‑CH V2
hl7:assignedAuthoringDevice
0 … 1The author as a device.
Contains 2.16.756.5.30.1.1.10.9.21 Device Compilation with name (DYNAMIC)
CDA‑CH V2
hl7:code
CE0 … 1RXDSSD‑44
@displayName
st1 … 1R
@code
cs1 … 1R
@codeSystem
oid1 … 1F1.2.840.10008.2.16.4
 CONF
The value of @code shall be drawn from value set 1.3.6.1.4.1.19376.1.2.20.11.1 DICOM Vocabulary (2017‑02‑06 14:01:56)
 Schematron assertroleyellow hint 
 test(@code = 'CAPTURE' and parent::node()/parent::node()/parent::node()/parent::node()/hl7:component/hl7:nonXMLBody/text/@mediaType = 'application/pdf') or (@code = 'WSD' and contains('parent::node()/parent::node()/parent::node()/parent::node()/hl7:component/hl7:nonXMLBody/text/@mediaType', 'text/plain') 
 MessageClinicalDocument/component/nonXMLBody/text@mediaType shall be "application/pdf" for PDF, or "text/plain" for plaintext 
hl7:manufacturerModelName
1 … 1RCDA‑CH V2
hl7:softwareName
1 … 1RCDA‑CH V2
hl7:representedOrganization
0 … 1The author's organization.
Contains 2.16.756.5.30.1.1.10.9.24 Organization Compilation with name (DYNAMIC)
CDA‑CH V2