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

Logical Model: Authenticator (CDA Class)

Official URL: http://hl7.org/fhir/cda/StructureDefinition/Authenticator Version: 2.1.0-draft1
Active as of 2023-01-16 Computable Name: CDAR2.Authenticator

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.

Usage:

  • This Logical Model Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. Authenticator 1..1BaseXML Namespace: urn:hl7-org:v3
Base for all types and resources
... @nullFlavor 0..1codeBinding: NullFlavor (required)
... @typeCode 0..1codeBinding: ParticipationType (required)
Fixed Value: AUTHEN
... realmCode 0..*CS
... templateId 0..*II
... time 1..1TS
... signatureCode 1..1CS
... sdtcSignatureText 0..1EDXML Namespace: urn:hl7-org:sdtc
XML: signatureText (urn:hl7-org:sdtc)
... assignedEntity 1..1AssignedEntity

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / Code
Authenticator.nullFlavorrequiredNullFlavor
Authenticator.typeCoderequiredFixed Value: AUTHEN
NameFlagsCard.TypeDescription & Constraintsdoco
.. Authenticator 1..1BaseBase for all types and resources
... nullFlavor 0..1codeBinding: NullFlavor (required)
... typeCode 0..1codeBinding: ParticipationType (required)
Fixed Value: AUTHEN
... realmCode 0..*CS
... templateId 0..*II
... time 1..1TS
... signatureCode 1..1CS
... sdtcSignatureText 0..1EDXML: signatureText (urn:hl7-org:sdtc)
... assignedEntity 1..1AssignedEntity

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Authenticator.nullFlavorrequiredNullFlavor
Authenticator.typeCoderequiredFixed Value: AUTHEN

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
NameFlagsCard.TypeDescription & Constraintsdoco
.. Authenticator 1..1BaseBase for all types and resources
... nullFlavor 0..1codeBinding: NullFlavor (required)
... typeCode 0..1codeBinding: ParticipationType (required)
Fixed Value: AUTHEN
... realmCode 0..*CS
... templateId 0..*II
... time 1..1TS
... signatureCode 1..1CS
... sdtcSignatureText 0..1EDXML: signatureText (urn:hl7-org:sdtc)
... assignedEntity 1..1AssignedEntity

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Authenticator.nullFlavorrequiredNullFlavor
Authenticator.typeCoderequiredFixed Value: AUTHEN

This structure is derived from Base

Summary

Mandatory: 0 element (3 nested mandatory elements)
Fixed Value: 1 element

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. Authenticator 1..1BaseXML Namespace: urn:hl7-org:v3
Base for all types and resources
... @nullFlavor 0..1codeBinding: NullFlavor (required)
... @typeCode 0..1codeBinding: ParticipationType (required)
Fixed Value: AUTHEN
... realmCode 0..*CS
... templateId 0..*II
... time 1..1TS
... signatureCode 1..1CS
... sdtcSignatureText 0..1EDXML Namespace: urn:hl7-org:sdtc
XML: signatureText (urn:hl7-org:sdtc)
... assignedEntity 1..1AssignedEntity

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / Code
Authenticator.nullFlavorrequiredNullFlavor
Authenticator.typeCoderequiredFixed Value: AUTHEN

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Authenticator 1..1BaseBase for all types and resources
... nullFlavor 0..1codeBinding: NullFlavor (required)
... typeCode 0..1codeBinding: ParticipationType (required)
Fixed Value: AUTHEN
... realmCode 0..*CS
... templateId 0..*II
... time 1..1TS
... signatureCode 1..1CS
... sdtcSignatureText 0..1EDXML: signatureText (urn:hl7-org:sdtc)
... assignedEntity 1..1AssignedEntity

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Authenticator.nullFlavorrequiredNullFlavor
Authenticator.typeCoderequiredFixed Value: AUTHEN

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Authenticator 1..1BaseBase for all types and resources
... nullFlavor 0..1codeBinding: NullFlavor (required)
... typeCode 0..1codeBinding: ParticipationType (required)
Fixed Value: AUTHEN
... realmCode 0..*CS
... templateId 0..*II
... time 1..1TS
... signatureCode 1..1CS
... sdtcSignatureText 0..1EDXML: signatureText (urn:hl7-org:sdtc)
... assignedEntity 1..1AssignedEntity

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Authenticator.nullFlavorrequiredNullFlavor
Authenticator.typeCoderequiredFixed Value: AUTHEN

This structure is derived from Base

Summary

Mandatory: 0 element (3 nested mandatory elements)
Fixed Value: 1 element

 

Other representations of profile: CSV, Excel