Clinical Document Architecture V2.0.1
2.1.0-draft1 - 1st Draft
Clinical Document Architecture V2.0.1
2.1.0-draft1 - 1st Draft
This page is part of the CDA: Clinical Document Architecture (v2.1.0-draft1: CDA 2.1 Draft) based on FHIR v5.0.0. . For a full list of available versions, see the Directory of published versions 
| Active as of 2023-01-16 |
XML representation of the Authenticator logical model.
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="Authenticator"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml">
<p>Represents a participant who has attested to the accuracy of the document, but who does not have privileges to legally authenticate the document. An example would be a resident physician who sees a patient and dictates a note, then later signs it.</p>
<p>A clinical document can have zero to many authenticators. While electronic signatures are not captured in a CDA document, both authentication and legal authentication require that a document has been signed manually or electronically by the responsible individual. An authenticator has a required authenticator.time indicating the time of authentication, and a required authenticator.signatureCode, indicating that a signature has been obtained and is on file.</p>
</div>
</text>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace">
<valueUri value="urn:hl7-org:v3"/>
</extension>
<url value="http://hl7.org/fhir/cda/StructureDefinition/Authenticator"/>
<version value="2.1.0-draft1"/>
<name value="CDAR2.Authenticator"/>
<title value="Authenticator (CDA Class)"/>
<status value="active"/>
<experimental value="false"/>
<date value="2023-01-16T16:39:50+11:00"/>
<publisher value="Health Level 7"/>
<contact>
<name value="HL7 International - Cross-Group Projects"/>
<telecom>
<system value="url"/>
<value value="http://www.hl7.org/Special/committees/cgp"/>
</telecom>
<telecom>
<system value="email"/>
<value value="cgp@lists.HL7.org"/>
</telecom>
</contact>
<description
value="Represents a participant who has attested to the accuracy of the document, but who does not have privileges to legally authenticate the document. An example would be a resident physician who sees a patient and dictates a note, then later signs it. A clinical document can have zero to many authenticators. While electronic signatures are not captured in a CDA document, both authentication and legal authentication require that a document has been signed manually or electronically by the responsible individual. An authenticator has a required authenticator.time indicating the time of authentication, and a required authenticator.signatureCode, indicating that a signature has been obtained and is on file."/>
<fhirVersion value="5.0.0-snapshot3"/>
<mapping>
<identity value="rim"/>
<uri value="http://hl7.org/v3"/>
<name value="RIM Mapping"/>
</mapping>
<kind value="logical"/>
<abstract value="false"/>
<type value="Authenticator"/>
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/Base"/>
<derivation value="specialization"/>
<snapshot>
<element id="Authenticator">
<path value="Authenticator"/>
<short value="Base for all types and resources"/>
<definition
value="Base definition for all types defined in FHIR type system."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="Base"/>
<min value="0"/>
<max value="*"/>
</base>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="Authenticator.nullFlavor">
<path value="Authenticator.nullFlavor"/>
<representation value="xmlAttr"/>
<label value="Exceptional Value Detail"/>
<definition
value="If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Authenticator.nullFlavor"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
</type>
<binding>
<strength value="required"/>
<valueSet value="http://terminology.hl7.org/ValueSet/v3-NullFlavor"/>
</binding>
</element>
<element id="Authenticator.typeCode">
<path value="Authenticator.typeCode"/>
<representation value="xmlAttr"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Authenticator.typeCode"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
</type>
<fixedCode value="AUTHEN"/>
<binding>
<strength value="required"/>
<valueSet
value="http://terminology.hl7.org/ValueSet/v3-ParticipationType"/>
</binding>
</element>
<element id="Authenticator.realmCode">
<path value="Authenticator.realmCode"/>
<definition
value="When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Authenticator.realmCode"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="http://hl7.org/fhir/cda/StructureDefinition/CS"/>
</type>
</element>
<element id="Authenticator.typeId">
<path value="Authenticator.typeId"/>
<definition
value="When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Authenticator.typeId"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="http://hl7.org/fhir/cda/StructureDefinition/II"/>
</type>
</element>
<element id="Authenticator.templateId">
<path value="Authenticator.templateId"/>
<definition
value="When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Authenticator.templateId"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="http://hl7.org/fhir/cda/StructureDefinition/II"/>
</type>
</element>
<element id="Authenticator.time">
<path value="Authenticator.time"/>
<min value="1"/>
<max value="1"/>
<base>
<path value="Authenticator.time"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="http://hl7.org/fhir/cda/StructureDefinition/TS"/>
</type>
</element>
<element id="Authenticator.signatureCode">
<path value="Authenticator.signatureCode"/>
<min value="1"/>
<max value="1"/>
<base>
<path value="Authenticator.signatureCode"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="http://hl7.org/fhir/cda/StructureDefinition/CS"/>
</type>
</element>
<element id="Authenticator.sdtcSignatureText">
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace">
<valueUri value="urn:hl7-org:sdtc"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-xml-name">
<valueString value="signatureText"/>
</extension>
<path value="Authenticator.sdtcSignatureText"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Authenticator.sdtcSignatureText"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="http://hl7.org/fhir/cda/StructureDefinition/ED"/>
</type>
</element>
<element id="Authenticator.assignedEntity">
<path value="Authenticator.assignedEntity"/>
<min value="1"/>
<max value="1"/>
<base>
<path value="Authenticator.assignedEntity"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code
value="http://hl7.org/fhir/cda/StructureDefinition/AssignedEntity"/>
</type>
</element>
</snapshot>
<differential>
<element id="Authenticator">
<path value="Authenticator"/>
<min value="1"/>
<max value="1"/>
</element>
<element id="Authenticator.nullFlavor">
<path value="Authenticator.nullFlavor"/>
<representation value="xmlAttr"/>
<label value="Exceptional Value Detail"/>
<definition
value="If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing."/>
<min value="0"/>
<max value="1"/>
<type>
<code value="code"/>
</type>
<binding>
<strength value="required"/>
<valueSet value="http://terminology.hl7.org/ValueSet/v3-NullFlavor"/>
</binding>
</element>
<element id="Authenticator.typeCode">
<path value="Authenticator.typeCode"/>
<representation value="xmlAttr"/>
<min value="0"/>
<max value="1"/>
<type>
<code value="code"/>
</type>
<fixedCode value="AUTHEN"/>
<binding>
<strength value="required"/>
<valueSet
value="http://terminology.hl7.org/ValueSet/v3-ParticipationType"/>
</binding>
</element>
<element id="Authenticator.realmCode">
<path value="Authenticator.realmCode"/>
<definition
value="When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"/>
<min value="0"/>
<max value="*"/>
<type>
<code value="http://hl7.org/fhir/cda/StructureDefinition/CS"/>
</type>
</element>
<element id="Authenticator.typeId">
<path value="Authenticator.typeId"/>
<definition
value="When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."/>
<min value="0"/>
<max value="1"/>
<type>
<code value="http://hl7.org/fhir/cda/StructureDefinition/II"/>
</type>
</element>
<element id="Authenticator.templateId">
<path value="Authenticator.templateId"/>
<definition
value="When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question"/>
<min value="0"/>
<max value="*"/>
<type>
<code value="http://hl7.org/fhir/cda/StructureDefinition/II"/>
</type>
</element>
<element id="Authenticator.time">
<path value="Authenticator.time"/>
<min value="1"/>
<max value="1"/>
<type>
<code value="http://hl7.org/fhir/cda/StructureDefinition/TS"/>
</type>
</element>
<element id="Authenticator.signatureCode">
<path value="Authenticator.signatureCode"/>
<min value="1"/>
<max value="1"/>
<type>
<code value="http://hl7.org/fhir/cda/StructureDefinition/CS"/>
</type>
</element>
<element id="Authenticator.sdtcSignatureText">
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace">
<valueUri value="urn:hl7-org:sdtc"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-xml-name">
<valueString value="signatureText"/>
</extension>
<path value="Authenticator.sdtcSignatureText"/>
<min value="0"/>
<max value="1"/>
<type>
<code value="http://hl7.org/fhir/cda/StructureDefinition/ED"/>
</type>
</element>
<element id="Authenticator.assignedEntity">
<path value="Authenticator.assignedEntity"/>
<min value="1"/>
<max value="1"/>
<type>
<code
value="http://hl7.org/fhir/cda/StructureDefinition/AssignedEntity"/>
</type>
</element>
</differential>
</StructureDefinition>
IG © 2019+ Health Level 7. Package hl7.cda.uv.core#2.1.0-draft1 based on FHIR 5.0.0-snapshot3. Generated 2023-01-16
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change