Back To Index  <<  Back To Templates

active Template  Author

Id 2.16.756.5.30.1.1.10.9.23 Effective Date 2018‑04‑18
Other versions this id:
Status active Active Version Label 2017
Name cdach_other_Author Display Name 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.
Context Parent nodes of template element with id 2.16.756.5.30.1.1.10.9.23
Label CDA‑CH V2
Classification Template type not specified
Open/Closed Open (other than defined elements are allowed)
Associated with
Associated with 3 concepts
Id Name Data Set
hl7chcda-dataelement-233 draft Identifier draft CDA-CH V2 2017
hl7chcda-dataelement-234 draft Health facility draft CDA-CH V2 2017
hl7chcda-dataelement-162 draft personIdentification draft CDA-CH V2 2017
Used by / Uses
Used by 0 transactions and 0 templates, Uses 4 templates
Uses as Name Version
2.16.756.5.30.1.1.10.9.35 Containment active Address Information Compilation - eCH-0010 (2017) DYNAMIC
2.16.756.5.30.1.1.10.9.34 Containment active Person Name Information Compilation - eCH-0011 (2017) DYNAMIC
2.16.756.5.30.1.1.10.9.21 Containment active Device Compilation with name (2017) DYNAMIC
2.16.756.5.30.1.1.10.9.24 Containment active Organization Compilation with name (2017) DYNAMIC
Relationship 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>
Item DT Card Conf Description Label
hl7:author
 1 … * R 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
The value of @code shall be drawn from value set 2.16.756.5.30.1.127.3.10.1.1.3 DocumentEntry.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 assert role red error  
  test (@code and @codeSystem) or (@nullFlavor='NAV')  
  Message Either a code with its code system or nullFlavor='NAV' is required.  
  Schematron assert role red 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 red 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
 
target
hl7chcda-dataelement-233 draft Identifier draft CDA-CH V2 2017
hl7chcda-dataelement-162 draft personIdentification draft CDA-CH V2 2017
@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 red 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
 
target
hl7chcda-dataelement-162 draft personIdentification draft CDA-CH V2 2017
@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
 
target
hl7chcda-dataelement-234 draft Health facility draft CDA-CH V2 2017