FHIR © HL7.org  |  Server Home  |  FHIR Server FHIR Server 3.4.11  |  FHIR Version n/a  User: [n/a]

Resource StructureDefinition/FHIR Server from package au.digitalhealth.cda.schema#current (31 ms)

Package au.digitalhealth.cda.schema
Type StructureDefinition
Id Id
FHIR Version R5
Source http://ns.electronichealth.net.au/cda/https://build.fhir.org/ig/AuDigitalHealth/cda-au-schema/StructureDefinition-au-LegalAuthenticator.html
Url http://ns.electronichealth.net.au/cda/StructureDefinition/au-LegalAuthenticator
Version 0.1.0
Status active
Date 2024-10-27T22:56:48+00:00
Name au-LegalAuthenticator
Title ADHA LegalAuthenticator (CDA Class)
Experimental False
Realm au
Authority national
Description **Australian adaptation of the [HL7 International CDA LegalAuthenticator class]( https://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-LegalAuthenticator.html)**. This is a generated StructureDefinition that describes CDA - that is, CDA as it actually is for R2. The intent of this StructureDefinition is to enable CDA to be a FHIR resource. That enables the FHIR infrastructure - API, conformance, query - to be used directly against CDA
Copyright Copyright © 2024 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See [https://creativecommons.org/licenses/by/4.0/](https://creativecommons.org/licenses/by/4.0/).
Type http://hl7.org/cda/stds/core/StructureDefinition/LegalAuthenticator
Kind logical

Resources that use this resource

StructureDefinition
au-ClinicalDocument ADHA ClinicalDocument (CDA Class)

Resources that this resource uses

StructureDefinition
http://hl7.org/cda/stds/core/StructureDefinition/CS CS: CodedSimpleValue (V3 Data Type)
http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot InfrastructureRoot (Base Type for all CDA Classes)
http://hl7.org/cda/stds/core/StructureDefinition/TS TS: PointInTime (V3 Data Type)
au-AssignedEntity ADHA AssignedEntity (CDA Class)
http://hl7.org/cda/stds/core/StructureDefinition/cs-simple cs: Coded Simple Value
http://hl7.org/cda/stds/core/ValueSet/CDAContextControl CDAContextControl
http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType CDAParticipationType
http://hl7.org/cda/stds/core/ValueSet/CDASignatureCode CDASignatureCode


Narrative

Note: links and images are rebased to the (stated) source

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.


Source

{
  "resourceType" : "StructureDefinition",
  "id" : "au-LegalAuthenticator",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <p>Represents a participant who has legally authenticated the document.</p>\n <p>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).</p>\n <p>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.</p>\n </div>"
  },
  "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/tools/StructureDefinition/xml-namespace",
      "valueUri" : "urn:hl7-org:v3"
    },
    {
      "url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
      "valueString" : "legalAuthenticator"
    },
    {
      "url" : "http://hl7.org/fhir/tools/StructureDefinition/logical-container",
      "valueUri" : "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument"
    },
    {
      "url" : "http://hl7.org/fhir/tools/StructureDefinition/type-profile-style",
      "valueUri" : "cda"
    }
  ],
  "url" : "http://ns.electronichealth.net.au/cda/StructureDefinition/au-LegalAuthenticator",
  "version" : "0.1.0",
  "name" : "au-LegalAuthenticator",
  "title" : "ADHA LegalAuthenticator (CDA Class)",
  "status" : "active",
  "experimental" : false,
  "date" : "2024-10-27T22:56:48+00:00",
  "publisher" : "Australian Digital Health Agency",
  "contact" : [
    {
      "name" : "Australian Digital Health Agency",
      "telecom" : [
        {
          "system" : "email",
          "value" : "mailto:help@digitalhealth.gov.au"
        }
      ]
    }
  ],
  "description" : "**Australian adaptation of the [HL7 International CDA LegalAuthenticator class]( https://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-LegalAuthenticator.html)**. \n\nThis is a generated StructureDefinition that describes CDA - that is, CDA as it actually is for R2. The intent of this StructureDefinition is to enable CDA to be a FHIR resource. That enables the FHIR infrastructure - API, conformance, query - to be used directly against CDA",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "AU"
        }
      ]
    }
  ],
  "copyright" : "Copyright © 2024 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See [https://creativecommons.org/licenses/by/4.0/](https://creativecommons.org/licenses/by/4.0/).",
  "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/LegalAuthenticator",
  "baseDefinition" : "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot",
  "derivation" : "specialization",
  "snapshot" : {
    "element" : [
      {
        "id" : "LegalAuthenticator",
        "path" : "LegalAuthenticator",
        "short" : "Australian adaptation of the HL7 International CDA LegalAuthenticator class",
        "definition" : "Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.",
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "Base",
          "min" : 0,
          "max" : "*"
        },
        "isModifier" : false,
        "mapping" : [
          {
            "identity" : "rim",
            "map" : "n/a"
          }
        ]
      },
      {
        "id" : "LegalAuthenticator.nullFlavor",
        "path" : "LegalAuthenticator.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" : "ANY.nullFlavor",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "code",
            "profile" : [
              "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
            ]
          }
        ],
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
        }
      },
      {
        "id" : "LegalAuthenticator.realmCode",
        "path" : "LegalAuthenticator.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" : "InfrastructureRoot.realmCode",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://hl7.org/cda/stds/core/StructureDefinition/CS"
          }
        ]
      },
      {
        "id" : "LegalAuthenticator.typeId",
        "path" : "LegalAuthenticator.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" : "InfrastructureRoot.typeId",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
          }
        ]
      },
      {
        "id" : "LegalAuthenticator.typeId.nullFlavor",
        "path" : "LegalAuthenticator.typeId.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" : "ANY.nullFlavor",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "code",
            "profile" : [
              "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
            ]
          }
        ],
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
        }
      },
      {
        "id" : "LegalAuthenticator.typeId.assigningAuthorityName",
        "path" : "LegalAuthenticator.typeId.assigningAuthorityName",
        "representation" : [
          "xmlAttr"
        ],
        "label" : "Assigning Authority Name",
        "definition" : "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "II.assigningAuthorityName",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "string",
            "profile" : [
              "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
            ]
          }
        ]
      },
      {
        "id" : "LegalAuthenticator.typeId.displayable",
        "path" : "LegalAuthenticator.typeId.displayable",
        "representation" : [
          "xmlAttr"
        ],
        "label" : "Displayable",
        "definition" : "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "II.displayable",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "boolean",
            "profile" : [
              "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
            ]
          }
        ]
      },
      {
        "id" : "LegalAuthenticator.typeId.root",
        "path" : "LegalAuthenticator.typeId.root",
        "representation" : [
          "xmlAttr"
        ],
        "label" : "Root",
        "definition" : "Identifies the type as an HL7 Registered model",
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "II.root",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "string",
            "profile" : [
              "http://hl7.org/cda/stds/core/StructureDefinition/oid",
              "http://hl7.org/cda/stds/core/StructureDefinition/uuid",
              "http://hl7.org/cda/stds/core/StructureDefinition/ruid"
            ]
          }
        ],
        "fixedString" : "2.16.840.1.113883.1.3"
      },
      {
        "id" : "LegalAuthenticator.typeId.extension",
        "path" : "LegalAuthenticator.typeId.extension",
        "representation" : [
          "xmlAttr"
        ],
        "label" : "Extension",
        "definition" : "A character string as a unique identifier within the scope of the identifier root.",
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "II.extension",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "string",
            "profile" : [
              "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
            ]
          }
        ]
      },
      {
        "id" : "LegalAuthenticator.templateId",
        "path" : "LegalAuthenticator.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" : "InfrastructureRoot.templateId",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
          }
        ]
      },
      {
        "id" : "LegalAuthenticator.typeCode",
        "path" : "LegalAuthenticator.typeCode",
        "representation" : [
          "xmlAttr"
        ],
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "LegalAuthenticator.typeCode",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "code",
            "profile" : [
              "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
            ]
          }
        ],
        "fixedCode" : "LA",
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType"
        }
      },
      {
        "id" : "LegalAuthenticator.contextControlCode",
        "path" : "LegalAuthenticator.contextControlCode",
        "representation" : [
          "xmlAttr"
        ],
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "LegalAuthenticator.contextControlCode",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "code",
            "profile" : [
              "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
            ]
          }
        ],
        "fixedCode" : "OP",
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDAContextControl"
        }
      },
      {
        "id" : "LegalAuthenticator.time",
        "path" : "LegalAuthenticator.time",
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "LegalAuthenticator.time",
          "min" : 1,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "http://hl7.org/cda/stds/core/StructureDefinition/TS"
          }
        ]
      },
      {
        "id" : "LegalAuthenticator.signatureCode",
        "path" : "LegalAuthenticator.signatureCode",
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "LegalAuthenticator.signatureCode",
          "min" : 1,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "http://hl7.org/cda/stds/core/StructureDefinition/CS"
          }
        ],
        "constraint" : [
          {
            "key" : "signature",
            "severity" : "warning",
            "human" : "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'.",
            "expression" : "code.exists() implies code != 'X'"
          }
        ],
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDASignatureCode"
        }
      },
      {
        "id" : "LegalAuthenticator.assignedEntity",
        "path" : "LegalAuthenticator.assignedEntity",
        "short" : "Australian-adapted AssignedEntity class",
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "LegalAuthenticator.assignedEntity",
          "min" : 1,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "http://ns.electronichealth.net.au/cda/StructureDefinition/au-AssignedEntity",
            "profile" : [
              "http://ns.electronichealth.net.au/cda/StructureDefinition/au-AssignedEntity"
            ]
          }
        ]
      }
    ]
  },
  "differential" : {
    "element" : [
      {
        "id" : "LegalAuthenticator",
        "path" : "LegalAuthenticator",
        "short" : "Australian adaptation of the HL7 International CDA LegalAuthenticator class",
        "min" : 1,
        "max" : "1"
      },
      {
        "id" : "LegalAuthenticator.typeCode",
        "path" : "LegalAuthenticator.typeCode",
        "representation" : [
          "xmlAttr"
        ],
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "code",
            "profile" : [
              "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
            ]
          }
        ],
        "fixedCode" : "LA",
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType"
        }
      },
      {
        "id" : "LegalAuthenticator.contextControlCode",
        "path" : "LegalAuthenticator.contextControlCode",
        "representation" : [
          "xmlAttr"
        ],
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "code",
            "profile" : [
              "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
            ]
          }
        ],
        "fixedCode" : "OP",
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDAContextControl"
        }
      },
      {
        "id" : "LegalAuthenticator.time",
        "path" : "LegalAuthenticator.time",
        "min" : 1,
        "max" : "1",
        "type" : [
          {
            "code" : "http://hl7.org/cda/stds/core/StructureDefinition/TS"
          }
        ]
      },
      {
        "id" : "LegalAuthenticator.signatureCode",
        "path" : "LegalAuthenticator.signatureCode",
        "min" : 1,
        "max" : "1",
        "type" : [
          {
            "code" : "http://hl7.org/cda/stds/core/StructureDefinition/CS"
          }
        ],
        "constraint" : [
          {
            "key" : "signature",
            "severity" : "warning",
            "human" : "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'.",
            "expression" : "code.exists() implies code != 'X'"
          }
        ],
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDASignatureCode"
        }
      },
      {
        "id" : "LegalAuthenticator.assignedEntity",
        "path" : "LegalAuthenticator.assignedEntity",
        "short" : "Australian-adapted AssignedEntity class",
        "min" : 1,
        "max" : "1",
        "type" : [
          {
            "code" : "http://ns.electronichealth.net.au/cda/StructureDefinition/au-AssignedEntity",
            "profile" : [
              "http://ns.electronichealth.net.au/cda/StructureDefinition/au-AssignedEntity"
            ]
          }
        ]
      }
    ]
  }
}

XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.