Cross Border Data Exchange IG
1.0.0 - CI Build International flag

Cross Border Data Exchange IG, published by IEHR-Workgroup. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/InteropEHRate-project/cross-border-data-exchange/ and changes regularly. See the Directory of published versions

Data Type Profile: Provenance-Signature - IEHR

Official URL: http://interopehrate.eu/fhir/StructureDefinition/Provenance-Signature-IEHR Version: 1.0.0
Draft as of 2024-04-08 Computable Name: ProvenanceSignatureIEHR

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Signature

NameFlagsCard.TypeDescription & Constraintsdoco
.. Signature Signature
... type S 1..1 Coding Indication of the reason the entity signed the object(s)
Fixed Value: As shown
.... system 1..1 uri Identity of the terminology system
Fixed Value: urn:iso-astm:E1762-95:2013
.... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 1.2.840.10065.1.12.1.5
.... display 1..1 string Representation defined by the system
Fixed Value: Verification Signature
... onBehalfOf S 0..0
... targetFormat S 1..1 code The technical format of the signed resources
Binding: TargetFormat ValueSet-IEHR (required)
... data S 1..1 base64Binary The actual signature content (XML DigSig. JWS, picture, etc.)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Signature.targetFormatrequiredTargetFormatValueSetIEHR
http://interopehrate.eu/fhir/ValueSet/TargetFormat-IEHR
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Signature 0..* Signature A Signature - XML DigSig, JWS, Graphical image of signature, etc.
... type SΣ 1..1 Coding Indication of the reason the entity signed the object(s)
Binding: SignatureTypeCodes (preferred): An indication of the reason that an entity signed the object.



Fixed Value: As shown
.... id 0..0 string Unique id for inter-element referencing
.... extension 0..0 Extension Additional content defined by implementations
.... system 1..1 uri Identity of the terminology system
Fixed Value: urn:iso-astm:E1762-95:2013
.... version 0..0 string Version of the system - if relevant
.... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 1.2.840.10065.1.12.1.5
.... display 1..1 string Representation defined by the system
Fixed Value: Verification Signature
.... userSelected 0..0 boolean If this coding was chosen directly by the user
... when Σ 1..1 instant When the signature was created
... who Σ 1..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who signed
... sigFormat S 1..1 code The technical format of the signature
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


Fixed Value: application/jose
... data S 1..1 base64Binary The actual signature content (XML DigSig. JWS, picture, etc.)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Signature.typepreferredFixed Value: 1.2.840.10065.1.12.1.5("Verification Signature")
http://hl7.org/fhir/ValueSet/signature-type
from the FHIR Standard
Signature.targetFormatrequiredTargetFormatValueSetIEHR
http://interopehrate.eu/fhir/ValueSet/TargetFormat-IEHR
from this IG
Signature.sigFormatrequiredFixed Value: application/jose
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
NameFlagsCard.TypeDescription & Constraintsdoco
.. Signature 0..* Signature A Signature - XML DigSig, JWS, Graphical image of signature, etc.
... id 0..1 string Unique id for inter-element referencing
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... type SΣ 1..1 Coding Indication of the reason the entity signed the object(s)
Binding: SignatureTypeCodes (preferred): An indication of the reason that an entity signed the object.



Fixed Value: As shown
.... id 0..0 string Unique id for inter-element referencing
.... extension 0..0 Extension Additional content defined by implementations
.... system 1..1 uri Identity of the terminology system
Fixed Value: urn:iso-astm:E1762-95:2013
.... version 0..0 string Version of the system - if relevant
.... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 1.2.840.10065.1.12.1.5
.... display 1..1 string Representation defined by the system
Fixed Value: Verification Signature
.... userSelected 0..0 boolean If this coding was chosen directly by the user
... who Σ 1..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who signed
... targetFormat S 1..1 code The technical format of the signed resources
Binding: TargetFormat ValueSet-IEHR (required)
... sigFormat S 1..1 code The technical format of the signature
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


Fixed Value: application/jose
... data S 1..1 base64Binary The actual signature content (XML DigSig. JWS, picture, etc.)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Signature.typepreferredFixed Value: 1.2.840.10065.1.12.1.5("Verification Signature")
http://hl7.org/fhir/ValueSet/signature-type
from the FHIR Standard
Signature.targetFormatrequiredTargetFormatValueSetIEHR
http://interopehrate.eu/fhir/ValueSet/TargetFormat-IEHR
from this IG
Signature.sigFormatrequiredFixed Value: application/jose
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Signature

Summary

Mandatory: 3 elements
Must-Support: 5 elements
Fixed: 2 elements
Prohibited: 1 element

Differential View

This structure is derived from Signature

NameFlagsCard.TypeDescription & Constraintsdoco
.. Signature Signature
... type S 1..1 Coding Indication of the reason the entity signed the object(s)
Fixed Value: As shown
.... system 1..1 uri Identity of the terminology system
Fixed Value: urn:iso-astm:E1762-95:2013
.... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 1.2.840.10065.1.12.1.5
.... display 1..1 string Representation defined by the system
Fixed Value: Verification Signature
... onBehalfOf S 0..0
... targetFormat S 1..1 code The technical format of the signed resources
Binding: TargetFormat ValueSet-IEHR (required)
... data S 1..1 base64Binary The actual signature content (XML DigSig. JWS, picture, etc.)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Signature.targetFormatrequiredTargetFormatValueSetIEHR
http://interopehrate.eu/fhir/ValueSet/TargetFormat-IEHR
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Signature 0..* Signature A Signature - XML DigSig, JWS, Graphical image of signature, etc.
... type SΣ 1..1 Coding Indication of the reason the entity signed the object(s)
Binding: SignatureTypeCodes (preferred): An indication of the reason that an entity signed the object.



Fixed Value: As shown
.... id 0..0 string Unique id for inter-element referencing
.... extension 0..0 Extension Additional content defined by implementations
.... system 1..1 uri Identity of the terminology system
Fixed Value: urn:iso-astm:E1762-95:2013
.... version 0..0 string Version of the system - if relevant
.... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 1.2.840.10065.1.12.1.5
.... display 1..1 string Representation defined by the system
Fixed Value: Verification Signature
.... userSelected 0..0 boolean If this coding was chosen directly by the user
... when Σ 1..1 instant When the signature was created
... who Σ 1..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who signed
... sigFormat S 1..1 code The technical format of the signature
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


Fixed Value: application/jose
... data S 1..1 base64Binary The actual signature content (XML DigSig. JWS, picture, etc.)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Signature.typepreferredFixed Value: 1.2.840.10065.1.12.1.5("Verification Signature")
http://hl7.org/fhir/ValueSet/signature-type
from the FHIR Standard
Signature.targetFormatrequiredTargetFormatValueSetIEHR
http://interopehrate.eu/fhir/ValueSet/TargetFormat-IEHR
from this IG
Signature.sigFormatrequiredFixed Value: application/jose
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Signature 0..* Signature A Signature - XML DigSig, JWS, Graphical image of signature, etc.
... id 0..1 string Unique id for inter-element referencing
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... type SΣ 1..1 Coding Indication of the reason the entity signed the object(s)
Binding: SignatureTypeCodes (preferred): An indication of the reason that an entity signed the object.



Fixed Value: As shown
.... id 0..0 string Unique id for inter-element referencing
.... extension 0..0 Extension Additional content defined by implementations
.... system 1..1 uri Identity of the terminology system
Fixed Value: urn:iso-astm:E1762-95:2013
.... version 0..0 string Version of the system - if relevant
.... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 1.2.840.10065.1.12.1.5
.... display 1..1 string Representation defined by the system
Fixed Value: Verification Signature
.... userSelected 0..0 boolean If this coding was chosen directly by the user
... who Σ 1..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who signed
... targetFormat S 1..1 code The technical format of the signed resources
Binding: TargetFormat ValueSet-IEHR (required)
... sigFormat S 1..1 code The technical format of the signature
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


Fixed Value: application/jose
... data S 1..1 base64Binary The actual signature content (XML DigSig. JWS, picture, etc.)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Signature.typepreferredFixed Value: 1.2.840.10065.1.12.1.5("Verification Signature")
http://hl7.org/fhir/ValueSet/signature-type
from the FHIR Standard
Signature.targetFormatrequiredTargetFormatValueSetIEHR
http://interopehrate.eu/fhir/ValueSet/TargetFormat-IEHR
from this IG
Signature.sigFormatrequiredFixed Value: application/jose
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Signature

Summary

Mandatory: 3 elements
Must-Support: 5 elements
Fixed: 2 elements
Prohibited: 1 element

 

Other representations of profile: CSV, Excel, Schematron