Clinical Document Architecture
2.0.0-sd-ballot - ballot

Clinical Document Architecture, published by Health Level 7. This guide is not an authorized publication; it is the continuous build for version 2.0.0-sd-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/ahdis/cda-core-2.0/ and changes regularly. See the Directory of published versions

Logical Model: LegalAuthenticator (CDA Class)

Official URL: http://hl7.org/cda/stds/core/StructureDefinition/LegalAuthenticator Version: 2.0.0-sd-ballot
Active as of 2024-03-04 Computable Name: LegalAuthenticator

Represents a participant who has legally authenticated the document. The CDA is a standard that specifies the structure of exchanged clinical documents. In the case where a local document is transformed into a CDA document for exchange, authentication occurs on the local document, and that fact is reflected in the exchanged CDA document. A CDA document can reflect the unauthenticated, authenticated, or legally authenticated state. The unauthenticated state exists when no authentication information has been recorded (i.e., it is the absence of being either authenticated or legally authenticated). 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. A legalAuthenticator has a required legalAuthenticator.time indicating the time of authentication, and a required legalAuthenticator.signatureCode, indicating that a signature has been obtained and is on file.

Usage:

Formal Views of Profile Content

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

This structure is derived from InfrastructureRoot

NameFlagsCard.TypeDescription & Constraintsdoco
.. LegalAuthenticator 1..1InfrastructureRootXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @typeCode 0..1csBinding: ParticipationType (required)
Fixed Value: LA
... @contextControlCode 0..1csBinding: ContextControl (required)
Fixed Value: OP
... time 1..1TS
... 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 / CodeURI
LegalAuthenticator.typeCoderequiredFixed Value: LA
http://terminology.hl7.org/ValueSet/v3-ParticipationType
LegalAuthenticator.contextControlCoderequiredFixed Value: OP
http://terminology.hl7.org/ValueSet/v3-ContextControl
LegalAuthenticator.signatureCoderequiredCDASignatureCode
http://hl7.org/cda/stds/core/ValueSet/CDASignatureCode
from this IG

Constraints

IdGradePath(s)DetailsRequirements
signaturewarningLegalAuthenticator.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
.. LegalAuthenticator 1..1InfrastructureRootXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @typeCode 0..1csBinding: ParticipationType (required)
Fixed Value: LA
... @contextControlCode 0..1csBinding: ContextControl (required)
Fixed Value: OP
... time 1..1TS
... sdtcSignatureText 0..1EDXML Namespace: urn:hl7-org:sdtc
XML: signatureText (urn:hl7-org:sdtc)
... assignedEntity 1..1AssignedEntity

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
LegalAuthenticator.typeCoderequiredFixed Value: LA
http://terminology.hl7.org/ValueSet/v3-ParticipationType
LegalAuthenticator.contextControlCoderequiredFixed Value: OP
http://terminology.hl7.org/ValueSet/v3-ContextControl
LegalAuthenticator.signatureCoderequiredCDASignatureCode
http://hl7.org/cda/stds/core/ValueSet/CDASignatureCode
from this IG

Constraints

IdGradePath(s)DetailsRequirements
signaturewarningLegalAuthenticator.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
.. LegalAuthenticator 1..1InfrastructureRootXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1csBinding: CDANullFlavor (required)
... realmCode 0..*CS
... typeId 0..1II
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1st
.... @displayable 0..1bl
.... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1st
... @typeCode 0..1csBinding: ParticipationType (required)
Fixed Value: LA
... @contextControlCode 0..1csBinding: ContextControl (required)
Fixed Value: OP
... time 1..1TS
... signatureCode C1..1CSBinding: 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..1EDXML Namespace: urn:hl7-org:sdtc
XML: signatureText (urn:hl7-org:sdtc)
... assignedEntity 1..1AssignedEntity

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
LegalAuthenticator.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
LegalAuthenticator.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
LegalAuthenticator.typeCoderequiredFixed Value: LA
http://terminology.hl7.org/ValueSet/v3-ParticipationType
LegalAuthenticator.contextControlCoderequiredFixed Value: OP
http://terminology.hl7.org/ValueSet/v3-ContextControl
LegalAuthenticator.signatureCoderequiredCDASignatureCode
http://hl7.org/cda/stds/core/ValueSet/CDASignatureCode
from this IG

Constraints

IdGradePath(s)DetailsRequirements
signaturewarningLegalAuthenticator.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

Summary

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

Structures

This structure refers to these other structures:

Differential View

This structure is derived from InfrastructureRoot

NameFlagsCard.TypeDescription & Constraintsdoco
.. LegalAuthenticator 1..1InfrastructureRootXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @typeCode 0..1csBinding: ParticipationType (required)
Fixed Value: LA
... @contextControlCode 0..1csBinding: ContextControl (required)
Fixed Value: OP
... time 1..1TS
... 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 / CodeURI
LegalAuthenticator.typeCoderequiredFixed Value: LA
http://terminology.hl7.org/ValueSet/v3-ParticipationType
LegalAuthenticator.contextControlCoderequiredFixed Value: OP
http://terminology.hl7.org/ValueSet/v3-ContextControl
LegalAuthenticator.signatureCoderequiredCDASignatureCode
http://hl7.org/cda/stds/core/ValueSet/CDASignatureCode
from this IG

Constraints

IdGradePath(s)DetailsRequirements
signaturewarningLegalAuthenticator.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
.. LegalAuthenticator 1..1InfrastructureRootXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @typeCode 0..1csBinding: ParticipationType (required)
Fixed Value: LA
... @contextControlCode 0..1csBinding: ContextControl (required)
Fixed Value: OP
... time 1..1TS
... sdtcSignatureText 0..1EDXML Namespace: urn:hl7-org:sdtc
XML: signatureText (urn:hl7-org:sdtc)
... assignedEntity 1..1AssignedEntity

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
LegalAuthenticator.typeCoderequiredFixed Value: LA
http://terminology.hl7.org/ValueSet/v3-ParticipationType
LegalAuthenticator.contextControlCoderequiredFixed Value: OP
http://terminology.hl7.org/ValueSet/v3-ContextControl
LegalAuthenticator.signatureCoderequiredCDASignatureCode
http://hl7.org/cda/stds/core/ValueSet/CDASignatureCode
from this IG

Constraints

IdGradePath(s)DetailsRequirements
signaturewarningLegalAuthenticator.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
.. LegalAuthenticator 1..1InfrastructureRootXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1csBinding: CDANullFlavor (required)
... realmCode 0..*CS
... typeId 0..1II
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1st
.... @displayable 0..1bl
.... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1st
... @typeCode 0..1csBinding: ParticipationType (required)
Fixed Value: LA
... @contextControlCode 0..1csBinding: ContextControl (required)
Fixed Value: OP
... time 1..1TS
... signatureCode C1..1CSBinding: 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..1EDXML Namespace: urn:hl7-org:sdtc
XML: signatureText (urn:hl7-org:sdtc)
... assignedEntity 1..1AssignedEntity

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
LegalAuthenticator.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
LegalAuthenticator.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
LegalAuthenticator.typeCoderequiredFixed Value: LA
http://terminology.hl7.org/ValueSet/v3-ParticipationType
LegalAuthenticator.contextControlCoderequiredFixed Value: OP
http://terminology.hl7.org/ValueSet/v3-ContextControl
LegalAuthenticator.signatureCoderequiredCDASignatureCode
http://hl7.org/cda/stds/core/ValueSet/CDASignatureCode
from this IG

Constraints

IdGradePath(s)DetailsRequirements
signaturewarningLegalAuthenticator.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

Summary

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

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel