Signature.profile.json

StructureDefinition for Signature

{
  "resourceType": "StructureDefinition",
  "id": "Signature",
  "meta": {
    "lastUpdated": "2015-04-03T14:24:32.000+11:00"
  },
  "text": {
    "status": "generated",
    "div": "<div>!-- Snipped for Brevity --></div>"
  },
  "url": "http://hl7.org/fhir/StructureDefinition/Signature",
  "name": "Signature",
  "publisher": "HL7 FHIR Standard",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.org/fhir"
        }
      ]
    }
  ],
  "description": "Base StructureDefinition for Signature Resource",
  "requirements": "There are a number of places where content must be signed in healthcare.",
  "status": "draft",
  "date": "2015-04-03T14:24:32+11:00",
  "mapping": [
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM"
    }
  ],
  "type": "type",
  "abstract": false,
  "base": "http://hl7.org/fhir/StructureDefinition/Element",
  "snapshot": {
    "element": [
      {
        "path": "Signature",
        "short": "An XML digital Signature",
        "definition": "An XML digital signature along with supporting context.",
        "comments": "The elements of the Signature Resource are for ease of access of these elements. The non-repudiation proof comes from the XML-Signature  validation, which includes validation of the referenced objects (e.g., Resources) (a.k.a., Content) in the XML-Signature Detached form.",
        "requirements": "There are a number of places where content must be signed in healthcare.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "Element"
          }
        ]
      },
      {
        "path": "Signature.id",
        "representation": [
          "xmlAttr"
        ],
        "short": "xml:id (or equivalent in JSON)",
        "definition": "unique id for the element within a resource (for internal references).",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "id"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "path": "Signature.extension",
        "short": "Additional Content defined by implementations",
        "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
        "comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
        "alias": [
          "extensions",
          "user content"
        ],
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Extension"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "path": "Signature.type",
        "short": "Indication of the reason the entity signed the object(s)",
        "definition": "An indication of the reason that the entity signed this document. This may be explicitly included as part of the signature information and can be used when determining accountability for various actions concerning the document.",
        "comments": "Examples include attesting to: authorship, correct transcription, and witness of specific event. Also known as a “Commitment Type Indication”.",
        "min": 1,
        "max": "*",
        "type": [
          {
            "code": "Coding"
          }
        ],
        "binding": {
          "name": "SignatureType",
          "strength": "preferred",
          "description": "An indication of the reason that an entity signed the object",
          "valueSetReference": {
            "reference": "http://hl7.org/fhir/vs/signature-type"
          }
        }
      },
      {
        "path": "Signature.when",
        "short": "When the signature was created",
        "definition": "When the digital signature was signed.",
        "comments": "This should agree with the information in the signature.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "instant"
          }
        ]
      },
      {
        "path": "Signature.who[x]",
        "short": "Who signed the signature",
        "definition": "A reference to an application-usable description of the person that signed the certificate (e.g. the signature used their private key).",
        "comments": "This should agree with the information in the signature.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "uri"
          },
          {
            "code": "Reference",
            "profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
          },
          {
            "code": "Reference",
            "profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
          },
          {
            "code": "Reference",
            "profile": "http://hl7.org/fhir/StructureDefinition/Patient"
          }
        ]
      },
      {
        "path": "Signature.blob",
        "short": "The actual XML Dig-Sig",
        "definition": "The base64 encoding of the XML-Signature.",
        "comments": "Where the signed content is a FHIR Resource(s), the signature is of the XML form of the Resource(s) using  XML-Signature (XMLDIG) \"Detached Signature\" form.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "base64Binary"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "path": "Signature",
        "short": "An XML digital Signature",
        "definition": "An XML digital signature along with supporting context.",
        "comments": "The elements of the Signature Resource are for ease of access of these elements. The non-repudiation proof comes from the XML-Signature  validation, which includes validation of the referenced objects (e.g., Resources) (a.k.a., Content) in the XML-Signature Detached form.",
        "requirements": "There are a number of places where content must be signed in healthcare.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "Element"
          }
        ]
      },
      {
        "path": "Signature.type",
        "short": "Indication of the reason the entity signed the object(s)",
        "definition": "An indication of the reason that the entity signed this document. This may be explicitly included as part of the signature information and can be used when determining accountability for various actions concerning the document.",
        "comments": "Examples include attesting to: authorship, correct transcription, and witness of specific event. Also known as a “Commitment Type Indication”.",
        "min": 1,
        "max": "*",
        "type": [
          {
            "code": "Coding"
          }
        ],
        "binding": {
          "name": "SignatureType",
          "strength": "preferred",
          "description": "An indication of the reason that an entity signed the object",
          "valueSetReference": {
            "reference": "http://hl7.org/fhir/vs/signature-type"
          }
        }
      },
      {
        "path": "Signature.when",
        "short": "When the signature was created",
        "definition": "When the digital signature was signed.",
        "comments": "This should agree with the information in the signature.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "instant"
          }
        ]
      },
      {
        "path": "Signature.who[x]",
        "short": "Who signed the signature",
        "definition": "A reference to an application-usable description of the person that signed the certificate (e.g. the signature used their private key).",
        "comments": "This should agree with the information in the signature.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "uri"
          },
          {
            "code": "Reference",
            "profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
          },
          {
            "code": "Reference",
            "profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
          },
          {
            "code": "Reference",
            "profile": "http://hl7.org/fhir/StructureDefinition/Patient"
          }
        ]
      },
      {
        "path": "Signature.blob",
        "short": "The actual XML Dig-Sig",
        "definition": "The base64 encoding of the XML-Signature.",
        "comments": "Where the signed content is a FHIR Resource(s), the signature is of the XML form of the Resource(s) using  XML-Signature (XMLDIG) \"Detached Signature\" form.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "base64Binary"
          }
        ]
      }
    ]
  }
}