Signature.profile.xml

StructureDefinition for Signature

Raw XML

<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="Signature"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><!-- Snipped for brevity --></div>
  </text>
  <url value="http://hl7.org/fhir/StructureDefinition/Signature"/>
  <name value="Signature"/>
  <publisher value="HL7 FHIR Standard"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://hl7.org/fhir"/>
    </telecom>
  </contact>
  <description value="Base StructureDefinition for Signature Resource"/>
  <requirements value="There are a number of places where content must be signed in healthcare."/>
  <status value="draft"/>
  <date value="2015-03-27T00:13:00+11:00"/>
  <mapping>
    <identity value="rim"/>
    <uri value="http://hl7.org/v3"/>
    <name value="RIM"/>
  </mapping>
  <type value="type"/>
  <abstract value="false"/>
  <base value="http://hl7.org/fhir/StructureDefinition/Element"/>
  <snapshot>
    <element>
      <path value="Signature"/>
      <short value="An XML digital Signature"/>
      <definition value="An XML digital signature along with supporting context."/>
      <comments value="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 value="There are a number of places where content must be signed in healthcare."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="Signature"/>
      </type>
    </element>
    <element>
      <path value="Signature.id"/>
      <representation value="xmlAttr"/>
      <short value="xml:id (or equivalent in JSON)"/>
      <definition value="unique id for the element within a resource (for internal references)."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="id"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element>
      <path value="Signature.extension"/>
      <short value="Additional Content defined by implementations"/>
      <definition value="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 value="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 value="extensions"/>
      <alias value="user content"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Extension"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element>
      <path value="Signature.type"/>
      <short value="Indication of the reason the entity signed the object(s)"/>
      <definition value="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 value="Examples include attesting to: authorship, correct transcription, and witness of specific
       event. Also known as a “Commitment Type Indication”."/>
      <min value="1"/>
      <max value="*"/>
      <type>
        <code value="Coding"/>
      </type>
      <binding>
        <name value="SignatureType"/>
        <strength value="preferred"/>
        <description value="An indication of the reason that an entity signed the object"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/vs/signature-type"/>
        </valueSetReference>
      </binding>
    </element>
    <element>
      <path value="Signature.when"/>
      <short value="When the signature was created"/>
      <definition value="When the digital signature was signed."/>
      <comments value="This should agree with the information in the signature."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="instant"/>
      </type>
    </element>
    <element>
      <path value="Signature.who[x]"/>
      <short value="Who signed the signature"/>
      <definition value="A reference to an application-usable description of the person that signed the certificate
       (e.g. the signature used their private key)."/>
      <comments value="This should agree with the information in the signature."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="uri"/>
      </type>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/Practitioner"/>
      </type>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/RelatedPerson"/>
      </type>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/Patient"/>
      </type>
    </element>
    <element>
      <path value="Signature.blob"/>
      <short value="The actual XML Dig-Sig"/>
      <definition value="The base64 encoding of the XML-Signature."/>
      <comments value="Where the signed content is a FHIR Resource(s), the signature is of the XML form of the
       Resource(s) using  XML-Signature (XMLDIG) &quot;Detached Signature&quot; form."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="base64Binary"/>
      </type>
    </element>
  </snapshot>
  <differential>
    <element>
      <path value="Signature"/>
      <short value="An XML digital Signature"/>
      <definition value="An XML digital signature along with supporting context."/>
      <comments value="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 value="There are a number of places where content must be signed in healthcare."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="Element"/>
      </type>
    </element>
    <element>
      <path value="Signature.type"/>
      <short value="Indication of the reason the entity signed the object(s)"/>
      <definition value="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 value="Examples include attesting to: authorship, correct transcription, and witness of specific
       event. Also known as a “Commitment Type Indication”."/>
      <min value="1"/>
      <max value="*"/>
      <type>
        <code value="Coding"/>
      </type>
      <binding>
        <name value="SignatureType"/>
        <strength value="preferred"/>
        <description value="An indication of the reason that an entity signed the object"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/vs/signature-type"/>
        </valueSetReference>
      </binding>
    </element>
    <element>
      <path value="Signature.when"/>
      <short value="When the signature was created"/>
      <definition value="When the digital signature was signed."/>
      <comments value="This should agree with the information in the signature."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="instant"/>
      </type>
    </element>
    <element>
      <path value="Signature.who[x]"/>
      <short value="Who signed the signature"/>
      <definition value="A reference to an application-usable description of the person that signed the certificate
       (e.g. the signature used their private key)."/>
      <comments value="This should agree with the information in the signature."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="uri"/>
      </type>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/Practitioner"/>
      </type>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/RelatedPerson"/>
      </type>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/Patient"/>
      </type>
    </element>
    <element>
      <path value="Signature.blob"/>
      <short value="The actual XML Dig-Sig"/>
      <definition value="The base64 encoding of the XML-Signature."/>
      <comments value="Where the signed content is a FHIR Resource(s), the signature is of the XML form of the
       Resource(s) using  XML-Signature (XMLDIG) &quot;Detached Signature&quot; form."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="base64Binary"/>
      </type>
    </element>
  </differential>
</StructureDefinition>