Occupational Data for Health (ODH) Implementation Guide: STU1 Ballot

This page is part of the Occupational Data for Health (ODH) FHIR IG (v0.1.0: STU 1 Ballot 1) based on FHIR R3. The current version which supercedes this version is 1.2.0. For a full list of available versions, see the Directory of published versions
SignatureProfile


<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="cimi-element-Signature"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
  <p><b>ODH Signature Profile</b></p>
  <p>A digital Signature - XML DigSig, JWT, Graphical image of signature, etc.</p>
  <p><b>ODH Mapping Summary</b></p>
  <p><pre>cimi.element.Signature maps to Signature:
  SignatureType maps to type
  CreationTime maps to when
  Signatory maps to who[x]
  OnBehalfOf maps to onBehalfOf[x]
  ContentType maps to contentType
  BinaryData maps to blob		
</pre></p>
</div>
  </text>
  <url
       value="http://hl7.org/fhir/us/odh/StructureDefinition/cimi-element-Signature"/>
  <identifier>
    <system value="http://hl7.org/fhir/us/odh"/>
    <value value="cimi.element.Signature"/>
  </identifier>
  <version value="0.1.0"/>
  <name value="SignatureProfile"/>
  <title value="ODH Signature Profile"/>
  <status value="draft"/>
  <date value="2018-08-17T00:00:00+10:00"/>
  <publisher value="HL7"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://standardhealthrecord.org"/>
    </telecom>
  </contact>
  <description
               value="A digital Signature - XML DigSig, JWT, Graphical image of signature, etc."/>
  <purpose
           value="There are a number of places where content must be signed in healthcare."/>
  <fhirVersion value="3.0.1"/>
  <mapping>
    <identity value="rim"/>
    <uri value="http://hl7.org/v3"/>
    <name value="RIM Mapping"/>
  </mapping>
  <kind value="complex-type"/>
  <abstract value="false"/>
  <type value="Signature"/>
  <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Signature"/>
  <derivation value="constraint"/>
  <snapshot>
    <element id="Signature:cimi-element-Signature">
      <path value="Signature"/>
      <short value="ODH Signature Profile"/>
      <definition
                  value="A digital Signature - XML DigSig, JWT, Graphical image of signature, etc."/>
      <comment
               value="The elements of the Signature Resource are for ease of access of these elements. Foro digital signatures (Xml DigSig, JWT), the non-repudiation proof comes from the Signature  validation, which includes validation of the referenced objects (e.g. Resources) (a.k.a., Content) in the XML-Signature Detached form."/>
      <min value="0"/>
      <max value="*"/>
      <condition value="ele-1"/>
      <constraint>
        <key value="ele-1"/>
        <severity value="error"/>
        <human value="All FHIR elements must have a @value or children"/>
        <expression value="hasValue() | (children().count() &gt; id.count())"/>
        <xpath value="@value|f:*|h:div"/>
        <source value="Element"/>
      </constraint>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element id="Signature:cimi-element-Signature.id">
      <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). This may be any string value that does not contain spaces."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="Element.id"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="string"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element id="Signature:cimi-element-Signature.extension">
      <path value="Signature.extension"/>
      <slicing>
        <discriminator>
          <type value="value"/>
          <path value="url"/>
        </discriminator>
        <description value="Extensions are always sliced by (at least) url"/>
        <rules value="open"/>
      </slicing>
      <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."/>
      <comment
               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="*"/>
      <base>
        <path value="Element.extension"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="Extension"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element id="Signature:cimi-element-Signature.type">
      <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."/>
      <comment
               value="Examples include attesting to: authorship, correct transcription, and witness of specific event. Also known as a &amp;quot;Commitment Type Indication&amp;quot;."/>
      <min value="1"/>
      <max value="*"/>
      <type>
        <code value="Coding"/>
      </type>
      <isSummary value="true"/>
      <binding>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
          <valueString value="SignatureType"/>
        </extension>
        <strength value="extensible"/>
        <description
                     value="An indication of the reason that an entity signed the object"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/ValueSet/signature-type"/>
        </valueSetReference>
      </binding>
    </element>
    <element id="Signature:cimi-element-Signature.when">
      <path value="Signature.when"/>
      <short value="When the signature was created"/>
      <definition value="When the digital signature was signed."/>
      <comment value="This should agree with the information in the signature."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="instant"/>
      </type>
      <isSummary value="true"/>
    </element>
    <element id="Signature:cimi-element-Signature.whoUri">
      <path value="Signature.whoUri"/>
      <short value="Who signed"/>
      <definition
                  value="A reference to an application-usable description of the identity that signed  (e.g. the signature used their private key)."/>
      <comment value="This should agree with the information in the signature."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="uri"/>
      </type>
      <isSummary value="true"/>
    </element>
    <element id="Signature:cimi-element-Signature.onBehalfOf[x]">
      <path value="Signature.onBehalfOf[x]"/>
      <short value="The party represented"/>
      <definition
                  value="A reference to an application-usable description of the identity that is represented by the signature."/>
      <comment value="The party that can&#39;t sign. For example a child."/>
      <requirements
                    value="used when the signature is on behalf of a non-signer."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="uri"/>
      </type>
      <type>
        <code value="Reference"/>
        <targetProfile
                       value="http://hl7.org/fhir/us/odh/StructureDefinition/cimi-entity-Organization"/>
      </type>
      <isSummary value="true"/>
    </element>
    <element id="Signature:cimi-element-Signature.contentType">
      <path value="Signature.contentType"/>
      <short value="The technical format of the signature"/>
      <definition
                  value="A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jwt for JWT, and image/* for a graphical image of a signature, etc."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <isSummary value="true"/>
      <binding>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
          <valueString value="MimeType"/>
        </extension>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding">
          <valueBoolean value="true"/>
        </extension>
        <strength value="required"/>
        <description
                     value="The mime type of an attachment. Any valid mime type is allowed."/>
        <valueSetUri value="http://www.rfc-editor.org/bcp/bcp13.txt"/>
      </binding>
    </element>
    <element id="Signature:cimi-element-Signature.blob">
      <path value="Signature.blob"/>
      <short
             value="The actual signature content (XML DigSig. JWT, picture, etc.)"/>
      <definition
                  value="The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty."/>
      <comment
               value="Where the signature type is an XML DigSig, 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="0"/>
      <max value="1"/>
      <type>
        <code value="base64Binary"/>
      </type>
    </element>
  </snapshot>
  <differential>
    <element id="Signature:cimi-element-Signature">
      <path value="Signature"/>
      <short value="ODH Signature Profile"/>
      <definition
                  value="A digital Signature - XML DigSig, JWT, Graphical image of signature, etc."/>
    </element>
    <element id="Signature:cimi-element-Signature.type">
      <path value="Signature.type"/>
      <binding>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
          <valueString value="SignatureType"/>
        </extension>
        <strength value="extensible"/>
        <description
                     value="An indication of the reason that an entity signed the object"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/ValueSet/signature-type"/>
        </valueSetReference>
      </binding>
    </element>
    <element id="Signature:cimi-element-Signature.whoUri">
      <path value="Signature.whoUri"/>
      <type>
        <code value="uri"/>
      </type>
    </element>
    <element id="Signature:cimi-element-Signature.onBehalfOf[x]">
      <path value="Signature.onBehalfOf[x]"/>
      <type>
        <code value="uri"/>
      </type>
      <type>
        <code value="Reference"/>
        <targetProfile
                       value="http://hl7.org/fhir/us/odh/StructureDefinition/cimi-entity-Organization"/>
      </type>
    </element>
  </differential>
</StructureDefinition>