FHIR IG analytics| Package | hl7.cda.uv.core |
| Resource Type | StructureDefinition |
| Id | StructureDefinition-Authenticator.json |
| FHIR Version | R5 |
No resources found
No resources found
Note: links and images are rebased to the (stated) source
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.
FHIR
FHIRsmith{
"resourceType": "StructureDefinition",
"id": "Authenticator",
"text": {
"status": "generated",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/logical-target",
"_valueBoolean": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
"valueCode": "not-applicable"
}
]
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
"valueUri": "urn:hl7-org:v3"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-xml-name",
"valueUri": "authenticator"
}
],
"url": "http://hl7.org/cda/stds/core/StructureDefinition/Authenticator",
"version": "2.0.1",
"name": "CDAR2.Authenticator",
"title": "Authenticator (CDA Class)",
"status": "active",
"experimental": false,
"date": "2023-10-03T20:44:04+00:00",
"publisher": "Health Level 7",
"contact": [
{
"name": "HL7 International - Structured Documents",
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/structdoc"
},
{
"system": "email",
"value": "structdog@lists.HL7.org"
}
]
}
],
"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": "5.0.0",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "logical",
"abstract": false,
"type": "http://hl7.org/cda/stds/core/StructureDefinition/Authenticator",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Base",
"derivation": "specialization",
"snapshot": {
"element": [
{
"id": "Authenticator",
"path": "Authenticator",
"short": "Base for all types and resources",
"definition": "Base definition for all types defined in FHIR type system.",
"min": 1,
"max": "1",
"base": {
"path": "Base",
"min": 0,
"max": "*"
},
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"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",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"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",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"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/cda/stds/core/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/cda/stds/core/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/cda/stds/core/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/cda/stds/core/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/cda/stds/core/StructureDefinition/CS"
}
]
},
{
"id": "Authenticator.sdtcSignatureText",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
"valueUri": "urn:hl7-org:sdtc"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-xml-name",
"valueString": "signatureText"
}
],
"path": "Authenticator.sdtcSignatureText",
"definition": "Element Authenticator.sdtcSignatureText",
"min": 0,
"max": "1",
"base": {
"path": "Authenticator.sdtcSignatureText",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/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/cda/stds/core/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",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"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",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"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/cda/stds/core/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/cda/stds/core/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/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id": "Authenticator.time",
"path": "Authenticator.time",
"min": 1,
"max": "1",
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/TS"
}
]
},
{
"id": "Authenticator.signatureCode",
"path": "Authenticator.signatureCode",
"min": 1,
"max": "1",
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
]
},
{
"id": "Authenticator.sdtcSignatureText",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
"valueUri": "urn:hl7-org:sdtc"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-xml-name",
"valueString": "signatureText"
}
],
"path": "Authenticator.sdtcSignatureText",
"definition": "Element Authenticator.sdtcSignatureText",
"min": 0,
"max": "1",
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ED"
}
]
},
{
"id": "Authenticator.assignedEntity",
"path": "Authenticator.assignedEntity",
"min": 1,
"max": "1",
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity"
}
]
}
]
}
}