Clinical Document Architecture V2.0.1
2.1.0 - CI Build
Clinical Document Architecture V2.0.1, published by Health Level 7. This is not an authorized publication; it is the continuous build for version 2.1.0). This version is based on the current content of https://github.com/HL7/cda-core-2.0/ and changes regularly. See the Directory of published versions
JSON representation of the Authenticator logical model.
{
"resourceType" : "StructureDefinition",
"id" : "Authenticator",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <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>\n <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>\n </div>"
},
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
"valueUri" : "urn:hl7-org:v3"
}
],
"url" : "http://hl7.org/fhir/cda/StructureDefinition/Authenticator",
"version" : "2.1.0",
"name" : "CDAR2.Authenticator",
"title" : "Authenticator (CDA Class)",
"status" : "active",
"experimental" : false,
"date" : "2021-03-11T17:00:55+00:00",
"publisher" : "Health Level 7",
"description" : "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" : "4.0.1",
"kind" : "logical",
"abstract" : false,
"type" : "Authenticator",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Base",
"derivation" : "specialization",
"snapshot" : {
"element" : [
{
"id" : "Authenticator",
"path" : "Authenticator",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Base",
"min" : 0,
"max" : "*"
},
"isModifier" : false
},
{
"id" : "Authenticator.nullFlavor",
"path" : "Authenticator.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Authenticator.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-NullFlavor"
}
},
{
"id" : "Authenticator.typeCode",
"path" : "Authenticator.typeCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Authenticator.typeCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"fixedCode" : "AUTHEN",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ParticipationType"
}
},
{
"id" : "Authenticator.realmCode",
"path" : "Authenticator.realmCode",
"definition" : "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" : 0,
"max" : "*",
"base" : {
"path" : "Authenticator.realmCode",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CS"
}
]
},
{
"id" : "Authenticator.typeId",
"path" : "Authenticator.typeId",
"definition" : "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" : 0,
"max" : "1",
"base" : {
"path" : "Authenticator.typeId",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "Authenticator.templateId",
"path" : "Authenticator.templateId",
"definition" : "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" : 0,
"max" : "*",
"base" : {
"path" : "Authenticator.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "Authenticator.time",
"path" : "Authenticator.time",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Authenticator.time",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/TS"
}
]
},
{
"id" : "Authenticator.signatureCode",
"path" : "Authenticator.signatureCode",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Authenticator.signatureCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CS"
}
]
},
{
"id" : "Authenticator.signatureText",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
"valueUri" : "urn:hl7-org:sdtc"
}
],
"path" : "Authenticator.signatureText",
"short" : "sdtc:signatureText",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Authenticator.signatureText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/ED"
}
]
},
{
"id" : "Authenticator.assignedEntity",
"path" : "Authenticator.assignedEntity",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Authenticator.assignedEntity",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/AssignedEntity"
}
]
}
]
},
"differential" : {
"element" : [
{
"id" : "Authenticator",
"path" : "Authenticator",
"min" : 1,
"max" : "1"
},
{
"id" : "Authenticator.nullFlavor",
"path" : "Authenticator.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "code"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-NullFlavor"
}
},
{
"id" : "Authenticator.typeCode",
"path" : "Authenticator.typeCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "code"
}
],
"fixedCode" : "AUTHEN",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ParticipationType"
}
},
{
"id" : "Authenticator.realmCode",
"path" : "Authenticator.realmCode",
"definition" : "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" : 0,
"max" : "*",
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CS"
}
]
},
{
"id" : "Authenticator.typeId",
"path" : "Authenticator.typeId",
"definition" : "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" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "Authenticator.templateId",
"path" : "Authenticator.templateId",
"definition" : "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" : 0,
"max" : "*",
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "Authenticator.time",
"path" : "Authenticator.time",
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/TS"
}
]
},
{
"id" : "Authenticator.signatureCode",
"path" : "Authenticator.signatureCode",
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CS"
}
]
},
{
"id" : "Authenticator.signatureText",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
"valueUri" : "urn:hl7-org:sdtc"
}
],
"path" : "Authenticator.signatureText",
"short" : "sdtc:signatureText",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/ED"
}
]
},
{
"id" : "Authenticator.assignedEntity",
"path" : "Authenticator.assignedEntity",
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/AssignedEntity"
}
]
}
]
}
}