Clinical Document Architecture
2.0.0-sd-202406-matchbox-patch - release

Clinical Document Architecture - Local Development build (v2.0.0-sd-202406-matchbox-patch) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Logical Model: Authenticator (CDA Class)

Official URL: http://hl7.org/cda/stds/core/StructureDefinition/Authenticator Version: 2.0.0-sd-202406-matchbox-patch
Active as of 2024-06-19 Computable Name: 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:

Formal Views of Template Content

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

This structure is derived from InfrastructureRoot

NameFlagsCard.TypeDescription & Constraintsdoco
.. Authenticator 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @typeCode 0..1 cs Binding: CDAParticipationType (required)
Fixed Value: AUTHEN
... time 1..1 TS
... signatureCode C 1..1 CS Binding: CDASignatureCode (required)
signature: CDA Release One represented either an intended ('X') or actual ('S') authenticator. CDA Release Two only represents an actual authenticator, so has deprecated the value of 'X'.
... assignedEntity 1..1 AssignedEntity

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / CodeURI
Authenticator.typeCoderequiredFixed Value: AUTHEN
http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
from this IG
Authenticator.signatureCoderequiredCDASignatureCode
http://hl7.org/cda/stds/core/ValueSet/CDASignatureCode
from this IG

Constraints

IdGradePath(s)DetailsRequirements
signaturewarningAuthenticator.signatureCodeCDA Release One represented either an intended ('X') or actual ('S') authenticator. CDA Release Two only represents an actual authenticator, so has deprecated the value of 'X'.
: code.exists() implies code != 'X'
NameFlagsCard.TypeDescription & Constraintsdoco
.. Authenticator 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @typeCode 0..1 cs Binding: CDAParticipationType (required)
Fixed Value: AUTHEN
... time 1..1 TS
... signatureCode C 1..1 CS Binding: CDASignatureCode (required)
signature: CDA Release One represented either an intended ('X') or actual ('S') authenticator. CDA Release Two only represents an actual authenticator, so has deprecated the value of 'X'.
... assignedEntity 1..1 AssignedEntity

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Authenticator.typeCoderequiredFixed Value: AUTHEN
http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
from this IG
Authenticator.signatureCoderequiredCDASignatureCode
http://hl7.org/cda/stds/core/ValueSet/CDASignatureCode
from this IG

Constraints

IdGradePath(s)DetailsRequirements
signaturewarningAuthenticator.signatureCodeCDA Release One represented either an intended ('X') or actual ('S') authenticator. CDA Release Two only represents an actual authenticator, so has deprecated the value of 'X'.
: code.exists() implies code != 'X'
NameFlagsCard.TypeDescription & Constraintsdoco
.. Authenticator 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId 0..1 II
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1 st
.... @displayable 0..1 bl
.... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1 st
... @typeCode 0..1 cs Binding: CDAParticipationType (required)
Fixed Value: AUTHEN
... time 1..1 TS
... signatureCode C 1..1 CS Binding: CDASignatureCode (required)
signature: CDA Release One represented either an intended ('X') or actual ('S') authenticator. CDA Release Two only represents an actual authenticator, so has deprecated the value of 'X'.
... sdtcSignatureText 0..1 ED XML Namespace: urn:hl7-org:sdtc
XML: signatureText (urn:hl7-org:sdtc)
... assignedEntity 1..1 AssignedEntity

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Authenticator.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
Authenticator.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
Authenticator.typeCoderequiredFixed Value: AUTHEN
http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
from this IG
Authenticator.signatureCoderequiredCDASignatureCode
http://hl7.org/cda/stds/core/ValueSet/CDASignatureCode
from this IG

Constraints

IdGradePath(s)DetailsRequirements
signaturewarningAuthenticator.signatureCodeCDA Release One represented either an intended ('X') or actual ('S') authenticator. CDA Release Two only represents an actual authenticator, so has deprecated the value of 'X'.
: code.exists() implies code != 'X'

This structure is derived from InfrastructureRoot

Differential View

This structure is derived from InfrastructureRoot

NameFlagsCard.TypeDescription & Constraintsdoco
.. Authenticator 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @typeCode 0..1 cs Binding: CDAParticipationType (required)
Fixed Value: AUTHEN
... time 1..1 TS
... signatureCode C 1..1 CS Binding: CDASignatureCode (required)
signature: CDA Release One represented either an intended ('X') or actual ('S') authenticator. CDA Release Two only represents an actual authenticator, so has deprecated the value of 'X'.
... assignedEntity 1..1 AssignedEntity

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / CodeURI
Authenticator.typeCoderequiredFixed Value: AUTHEN
http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
from this IG
Authenticator.signatureCoderequiredCDASignatureCode
http://hl7.org/cda/stds/core/ValueSet/CDASignatureCode
from this IG

Constraints

IdGradePath(s)DetailsRequirements
signaturewarningAuthenticator.signatureCodeCDA Release One represented either an intended ('X') or actual ('S') authenticator. CDA Release Two only represents an actual authenticator, so has deprecated the value of 'X'.
: code.exists() implies code != 'X'

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Authenticator 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @typeCode 0..1 cs Binding: CDAParticipationType (required)
Fixed Value: AUTHEN
... time 1..1 TS
... signatureCode C 1..1 CS Binding: CDASignatureCode (required)
signature: CDA Release One represented either an intended ('X') or actual ('S') authenticator. CDA Release Two only represents an actual authenticator, so has deprecated the value of 'X'.
... assignedEntity 1..1 AssignedEntity

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Authenticator.typeCoderequiredFixed Value: AUTHEN
http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
from this IG
Authenticator.signatureCoderequiredCDASignatureCode
http://hl7.org/cda/stds/core/ValueSet/CDASignatureCode
from this IG

Constraints

IdGradePath(s)DetailsRequirements
signaturewarningAuthenticator.signatureCodeCDA Release One represented either an intended ('X') or actual ('S') authenticator. CDA Release Two only represents an actual authenticator, so has deprecated the value of 'X'.
: code.exists() implies code != 'X'

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Authenticator 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId 0..1 II
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1 st
.... @displayable 0..1 bl
.... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1 st
... @typeCode 0..1 cs Binding: CDAParticipationType (required)
Fixed Value: AUTHEN
... time 1..1 TS
... signatureCode C 1..1 CS Binding: CDASignatureCode (required)
signature: CDA Release One represented either an intended ('X') or actual ('S') authenticator. CDA Release Two only represents an actual authenticator, so has deprecated the value of 'X'.
... sdtcSignatureText 0..1 ED XML Namespace: urn:hl7-org:sdtc
XML: signatureText (urn:hl7-org:sdtc)
... assignedEntity 1..1 AssignedEntity

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Authenticator.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
Authenticator.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
Authenticator.typeCoderequiredFixed Value: AUTHEN
http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
from this IG
Authenticator.signatureCoderequiredCDASignatureCode
http://hl7.org/cda/stds/core/ValueSet/CDASignatureCode
from this IG

Constraints

IdGradePath(s)DetailsRequirements
signaturewarningAuthenticator.signatureCodeCDA Release One represented either an intended ('X') or actual ('S') authenticator. CDA Release Two only represents an actual authenticator, so has deprecated the value of 'X'.
: code.exists() implies code != 'X'

This structure is derived from InfrastructureRoot

 

Other representations of profile: CSV, Excel