Profile Comparison between http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-signature-bundle vs http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-signature-bundle

Messages

Metadata

Name	Value		Comments
abstract	false
baseDefinition	http://hl7.org/fhir/StructureDefinition/Bundle
copyright	Used by permission of HL7 International all rights reserved Creative Commons License
date	2022-08-08T15:11:35+00:00	2023-01-15	Values Differ
description	This Bundle profile enforces the various elements of signature documented in the CDex guide. It adds the following *mandatory* (min=1) constraints: - A Bundle.signature element representing the enveloped signature - A Bundle.signature.type fixed to ASTM Standard, E1762-95(2013) code = “1.2.840.10065.1.12.1.5” (Verification Signature) - A Bundle.signature.who for the organization or practitioner who signed the Bundle which is either: 1. a reference to US-Core Practitioner, PractitionerRole or Organization or 1. an NPI or Tax ID and name of the organization or practitioner - A Bundle.signature.data representing base64 encoded JWS-Signature In addition, the following *mandatory* (min=1) element is inherited from the base standard: - Bundle.signature.when - system timestamp when the signature was created	This Bundle profile enforces the various elements of signature documented in the CDex guide to represent an enveloped signature. It adds the following *mandatory* (min=1) constraint: - A Bundle.signature element using the CDex Signature Profile	Values Differ
experimental
fhirVersion	4.0.1
jurisdiction
jurisdiction[0]	urn:iso:std:iso:3166#US
kind	resource
name	CDexSignatureBundle
publisher	HL7 International - Patient Care Work Group
purpose
status	active
title	CDex Signature Bundle Profile
type	Bundle
url	http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-signature-bundle
version	1.1.0	2.0.0	Values Differ

Structure

Name	L Flags	L Card.	L Type	L Description & Constraints	R Flags	R Card.	L Type	L Description & Constraints	Comments
Bundle	C	0..*	Bundle	Contains a collection of resources sb-1: The signature element must have either reference to the signer or the signer's identifier and name.	C	0..*	Bundle	Contains a collection of resources
id	Σ	0..1	string	Logical id of this artifact	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: ?? (preferred): A human language. Additional Bindings Purpose ?? Max Binding		0..1	code	Language of the resource content Binding: ?? (preferred): A human language. Additional Bindings Purpose ?? Max Binding
identifier	Σ	0..1	Identifier	Persistent identifier for the bundle	Σ	0..1	Identifier	Persistent identifier for the bundle
type	Σ	1..1	code	document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: ?? (required): Indicates the purpose of a bundle - how it is intended to be used.	Σ	1..1	code	document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: ?? (required): Indicates the purpose of a bundle - how it is intended to be used.
timestamp	Σ	0..1	instant	When the bundle was assembled	Σ	0..1	instant	When the bundle was assembled
total	ΣC	0..1	unsignedInt	If search, the total number of matches	ΣC	0..1	unsignedInt	If search, the total number of matches
link	Σ	0..*	BackboneElement	Links related to this Bundle	Σ	0..*	BackboneElement	Links related to this Bundle
id		0..1	string	Unique id for inter-element referencing		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relation	Σ	1..1	string	See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1	Σ	1..1	string	See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
url	Σ	1..1	uri	Reference details for the link	Σ	1..1	uri	Reference details for the link
entry	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id		0..1	string	Unique id for inter-element referencing		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
link	Σ	0..*	See link (Bundle)	Links related to this entry	Σ	0..*	See link (Bundle)	Links related to this entry
fullUrl	Σ	0..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)	Σ	0..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	Σ	0..1	Resource	A resource in the bundle	Σ	0..1	Resource	A resource in the bundle
search	ΣC	0..1	BackboneElement	Search related information	ΣC	0..1	BackboneElement	Search related information
id		0..1	string	Unique id for inter-element referencing		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
mode	Σ	0..1	code	match | include | outcome - why this is in the result set Binding: ?? (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.	Σ	0..1	code	match | include | outcome - why this is in the result set Binding: ?? (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.
score	Σ	0..1	decimal	Search ranking (between 0 and 1)	Σ	0..1	decimal	Search ranking (between 0 and 1)
request	ΣC	0..1	BackboneElement	Additional execution information (transaction/batch/history)	ΣC	0..1	BackboneElement	Additional execution information (transaction/batch/history)
id		0..1	string	Unique id for inter-element referencing		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
method	Σ	1..1	code	GET | HEAD | POST | PUT | DELETE | PATCH Binding: ?? (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.	Σ	1..1	code	GET | HEAD | POST | PUT | DELETE | PATCH Binding: ?? (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
url	Σ	1..1	uri	URL for HTTP equivalent of this entry	Σ	1..1	uri	URL for HTTP equivalent of this entry
ifNoneMatch	Σ	0..1	string	For managing cache currency	Σ	0..1	string	For managing cache currency
ifModifiedSince	Σ	0..1	instant	For managing cache currency	Σ	0..1	instant	For managing cache currency
ifMatch	Σ	0..1	string	For managing update contention	Σ	0..1	string	For managing update contention
ifNoneExist	Σ	0..1	string	For conditional creates	Σ	0..1	string	For conditional creates
response	ΣC	0..1	BackboneElement	Results of execution (transaction/batch/history)	ΣC	0..1	BackboneElement	Results of execution (transaction/batch/history)
id		0..1	string	Unique id for inter-element referencing		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
status	Σ	1..1	string	Status response code (text optional)	Σ	1..1	string	Status response code (text optional)
location	Σ	0..1	uri	The location (if the operation returns a location)	Σ	0..1	uri	The location (if the operation returns a location)
etag	Σ	0..1	string	The Etag for the resource (if relevant)	Σ	0..1	string	The Etag for the resource (if relevant)
lastModified	Σ	0..1	instant	Server's date time modified	Σ	0..1	instant	Server's date time modified
outcome	Σ	0..1	Resource	OperationOutcome with hints and warnings (for batch/transaction)	Σ	0..1	Resource	OperationOutcome with hints and warnings (for batch/transaction)
signature	SΣ	1..1	Signature	Digital Signature	SC	1..1	??	JWS Digital Signature	Elements differ in short: 'Digital Signature' vs 'JWS Digital Signature' Elements differ in definition: 'Digital Signature - base64 encoded. XML-DSig or a JWT.' vs 'A JWS digital signature along with supporting context.' Elements differ in comments: 'The signature could be created by the "author" of the bundle or by the originating device. Requirements around inclusion of a signature, verification of signatures and treatment of signed/non-signed bundles is implementation-environment specific.' vs '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.'
id		0..1	string	Unique id for inter-element referencing		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for type	SΣ	1..*	Coding	Indication of the reason the entity signed the object(s) Slice: Unordered, Open by pattern:$this Binding: ?? (preferred): An indication of the reason that an entity signed the object.	Σ	1..*	Coding	Indication of the reason the entity signed the object(s) Binding: ?? (preferred): An indication of the reason that an entity signed the object.	Elements differ in definition for mustSupport: 'true' vs 'false'
when	SΣ	1..1	instant	When the signature was created	Σ	1..1	instant	When the signature was created	Elements differ in definition for mustSupport: 'true' vs 'false'
who	SΣ	1..1	Reference(US Core Practitioner Profile S | US Core Organization Profile S | US Core PractitionerRole Profile)	Organization or practitioner who signed the Bundle	Σ	1..1	Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)	Who signed	Elements differ in short: 'Organization or practitioner who signed the Bundle' vs 'Who signed' Elements differ in definition for mustSupport: 'true' vs 'false'
id		0..1	string	Unique id for inter-element referencing		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	SΣC	0..1	string	Literal reference, Relative, internal or absolute URL	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL	Elements differ in definition for mustSupport: 'true' vs 'false'
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ?? (extensible): Aa resource (or, for logical models, the URI of the logical model).	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ?? (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	SΣC	0..1	Identifier	NPI or US Tax ID	Σ	0..1	Identifier	Logical reference, when literal reference is not known	Elements differ in short: 'NPI or US Tax ID' vs 'Logical reference, when literal reference is not known' Elements differ in definition: 'NPI or Tax ID representing the Provider or Organization' vs 'An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.' Elements differ in definition for mustSupport: 'true' vs 'false'
id		0..1	string	Unique id for inter-element referencing		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: ?? (required): Identifies the purpose for this identifier, if known .	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: ?? (required): Identifies the purpose for this identifier, if known .
type	SΣ	1..1	CodeableConcept	Description of identifier Binding: ?? (required)	Σ	0..1	CodeableConcept	Description of identifier Binding: ?? (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.	Elements differ in definition for mustSupport: 'true' vs 'false' Element minimum cardinalities differ: '1' vs '0'
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique Example General: 123456	Σ	0..1	string	The value that is unique Example General: 123456	Elements differ in definition for mustSupport: 'true' vs 'false' Element minimum cardinalities differ: '1' vs '0'
period	Σ	0..1	Period	Time period when id is/was valid for use	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
display	SΣC	0..1	string	Text alternative for the resource	Σ	0..1	string	Text alternative for the resource	Elements differ in definition for mustSupport: 'true' vs 'false'
onBehalfOf	Σ	0..1	Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)	The party represented	Σ	0..1	Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)	The party represented
targetFormat		0..1	code	The technical format of the signed resources Binding: ?? (required): The mime type of an attachment. Any valid mime type is allowed.		0..1	code	The technical format of the signed resources Binding: ?? (required): The mime type of an attachment. Any valid mime type is allowed.
sigFormat		0..1	code	The technical format of the signature Binding: ?? (required): The mime type of an attachment. Any valid mime type is allowed.		0..1	code	The technical format of the signature Binding: ?? (required): The mime type of an attachment. Any valid mime type is allowed.
data	S	1..1	base64Binary	base64 encoded JWS-Signature		0..1	base64Binary	The actual signature content (XML DigSig. JWS, picture, etc.)	Elements differ in short: 'base64 encoded JWS-Signature' vs 'The actual signature content (XML DigSig. JWS, picture, etc.)' Elements differ in definition for mustSupport: 'true' vs 'false' Element minimum cardinalities differ: '1' vs '0'
Documentation for this format