NHDR Implementation Guide Release 1.0
0.1.0 - ci-build

NHDR Implementation Guide Release 1.0, published by NHDR. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/UP-Manila-SILab/PhilHealth-NHDR-IG-Review/ and changes regularly. See the Directory of published versions

Data Type Profile: PH_Signature - Detailed Descriptions

Page standards status: Draft

Definitions for the PH-Signature data type profile.

Guidance on how to interpret the contents of this table can be foundhere

0. Signature
Definition

A signature along with supporting context. The signature may be a digital signature that is cryptographic in nature, or some other signature acceptable to the domain. This other signature may be as simple as a graphical image representing a hand-written signature, or a signature ceremony Different signature approaches have different utilities.

ShortA Signature - XML DigSig, JWS, Graphical image of signature, etc.
Comments

The elements of the Signature Resource are for ease of access of these elements. For digital signatures (Xml DigSig, JWS), 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.

Control0..*
This element is affected by the following invariants: ele-1
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. Signature.extension:signaturePosition
Slice NamesignaturePosition
Definition

Position or Occupation of the person who signed.

ShortPosition of the Signatory
Control0..*
TypeExtension(Position of the Signatory) (Extension Type: string)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
4. Signature.extension:signatureReason
Slice NamesignatureReason
Definition

Reason of the person who signed.

ShortReason for the Signature
Control0..*
TypeExtension(Reason for the Signature) (Extension Type: string)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
6. Signature.type
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.

ShortIndication of the reason the entity signed the object(s)
Comments

Examples include attesting to: authorship, correct transcription, and witness of specific event. Also known as a "Commitment Type Indication".

Control1..*
BindingThe codes SHALL be taken from The codes SHOULD be taken from Signature Typehttp://hl7.org/fhir/ValueSet/signature-type
(required to https://nhdr.gov.ph/fhir/ValueSet/SignatureTypeVS)
TypeCoding
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. Signature.when
Definition

When the digital signature was signed.

ShortWhen the signature was created
Comments

This should agree with the information in the signature.

Control1..1
Typeinstant
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. Signature.who
Definition

A reference to an application-usable description of the identity that signed (e.g. the signature used their private key).

ShortWho signed
Comments

This should agree with the information in the signature.

Control1..1
TypeReference(PH Patient, PH Organization, PH Practitioner, PH PractitionerRole, PH RelatedPerson, Device, Practitioner, PractitionerRole, RelatedPerson, Patient, Organization)
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. Signature.onBehalfOf
Definition

A reference to an application-usable description of the identity that is represented by the signature.

ShortThe party represented
Comments

The party that can't sign. For example a child.

Control0..1
TypeReference(PH Patient, PH Organization, PH Practitioner, PH PractitionerRole, PH RelatedPerson, Device, Practitioner, PractitionerRole, RelatedPerson, Patient, Organization)
Is Modifierfalse
Summarytrue
Requirements

used when the signature is on behalf of a non-signer.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. Signature.targetFormat
Definition

A mime type that indicates the technical format of the target resources signed by the signature.

ShortThe technical format of the signed resources
Comments

"xml", "json" and "ttl" are allowed, which describe the simple encodings described in the specification (and imply appropriate bundle support). Otherwise, mime types are legal here.

Control0..01
BindingThe codes SHALL be taken from Mime Typeshttp://hl7.org/fhir/ValueSet/mimetypes|4.0.1
(required to http://hl7.org/fhir/ValueSet/mimetypes|4.0.1)

The mime type of an attachment. Any valid mime type is allowed.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. Signature.sigFormat
Definition

A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jose for JWS, and image/* for a graphical image of a signature, etc.

ShortThe technical format of the signature
Control0..01
BindingThe codes SHALL be taken from Mime Typeshttp://hl7.org/fhir/ValueSet/mimetypes|4.0.1
(required to http://hl7.org/fhir/ValueSet/mimetypes|4.0.1)

The mime type of an attachment. Any valid mime type is allowed.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be foundhere

0. Signature
2. Signature.extension:signaturePosition
Slice NamesignaturePosition
Control0..*
TypeExtension(Position of the Signatory) (Extension Type: string)
4. Signature.extension:signatureReason
Slice NamesignatureReason
Control0..*
TypeExtension(Reason for the Signature) (Extension Type: string)
6. Signature.type
BindingThe codes SHALL be taken from Signature Type
(required to https://nhdr.gov.ph/fhir/ValueSet/SignatureTypeVS)
8. Signature.who
TypeReference(PH Patient, PH Organization, PH Practitioner, PH PractitionerRole, PH RelatedPerson, Device)
10. Signature.onBehalfOf
TypeReference(PH Patient, PH Organization, PH Practitioner, PH PractitionerRole, PH RelatedPerson, Device)
12. Signature.targetFormat
Control0..0
14. Signature.sigFormat
Control0..0

Guidance on how to interpret the contents of this table can be foundhere

0. Signature
Definition

A signature along with supporting context. The signature may be a digital signature that is cryptographic in nature, or some other signature acceptable to the domain. This other signature may be as simple as a graphical image representing a hand-written signature, or a signature ceremony Different signature approaches have different utilities.

ShortA Signature - XML DigSig, JWS, Graphical image of signature, etc.
Comments

The elements of the Signature Resource are for ease of access of these elements. For digital signatures (Xml DigSig, JWS), 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.

Control0..*
This element is affected by the following invariants: ele-1
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. Signature.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
4. Signature.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Signature.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 6. Signature.extension:signaturePosition
    Slice NamesignaturePosition
    Definition

    Position or Occupation of the person who signed.

    ShortPosition of the Signatory
    Control0..*
    TypeExtension(Position of the Signatory) (Extension Type: string)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    8. Signature.extension:signatureReason
    Slice NamesignatureReason
    Definition

    Reason of the person who signed.

    ShortReason for the Signature
    Control0..*
    TypeExtension(Reason for the Signature) (Extension Type: string)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    10. Signature.type
    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.

    ShortIndication of the reason the entity signed the object(s)
    Comments

    Examples include attesting to: authorship, correct transcription, and witness of specific event. Also known as a "Commitment Type Indication".

    Control1..*
    BindingThe codes SHALL be taken from Signature Type
    (required to https://nhdr.gov.ph/fhir/ValueSet/SignatureTypeVS)
    TypeCoding
    Is Modifierfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    12. Signature.when
    Definition

    When the digital signature was signed.

    ShortWhen the signature was created
    Comments

    This should agree with the information in the signature.

    Control1..1
    Typeinstant
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    14. Signature.who
    Definition

    A reference to an application-usable description of the identity that signed (e.g. the signature used their private key).

    ShortWho signed
    Comments

    This should agree with the information in the signature.

    Control1..1
    TypeReference(PH Patient, PH Organization, PH Practitioner, PH PractitionerRole, PH RelatedPerson, Device)
    Is Modifierfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    16. Signature.onBehalfOf
    Definition

    A reference to an application-usable description of the identity that is represented by the signature.

    ShortThe party represented
    Comments

    The party that can't sign. For example a child.

    Control0..1
    TypeReference(PH Patient, PH Organization, PH Practitioner, PH PractitionerRole, PH RelatedPerson, Device)
    Is Modifierfalse
    Summarytrue
    Requirements

    used when the signature is on behalf of a non-signer.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    18. Signature.targetFormat
    Definition

    A mime type that indicates the technical format of the target resources signed by the signature.

    ShortThe technical format of the signed resources
    Comments

    "xml", "json" and "ttl" are allowed, which describe the simple encodings described in the specification (and imply appropriate bundle support). Otherwise, mime types are legal here.

    Control0..0
    BindingThe codes SHALL be taken from Mime Types
    (required to http://hl7.org/fhir/ValueSet/mimetypes|4.0.1)

    The mime type of an attachment. Any valid mime type is allowed.

    Typecode
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    20. Signature.sigFormat
    Definition

    A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jose for JWS, and image/* for a graphical image of a signature, etc.

    ShortThe technical format of the signature
    Control0..0
    BindingThe codes SHALL be taken from Mime Types
    (required to http://hl7.org/fhir/ValueSet/mimetypes|4.0.1)

    The mime type of an attachment. Any valid mime type is allowed.

    Typecode
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    22. Signature.data
    Definition

    The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty.

    ShortThe actual signature content (XML DigSig. JWS, picture, etc.)
    Comments

    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) "Detached Signature" form.

    Control0..1
    Typebase64Binary
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))