abstractbaseDefinitioncopyrightdate- Values Differ
description- Values Differ
experimentalfhirVersionjurisdiction
jurisdiction[0]kindnamepublisher- Values Differ
purposestatustitletypeurlversion- Values Differ
| Left: | CDex Signature Bundle Profile (http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-signature-bundle) |
| Right: | CDex Signature Bundle Profile (http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-signature-bundle) |
| Error | StructureDefinition.version | Values for version differ: '1.1.0' vs '2.1.0-preview' |
| Information | StructureDefinition.date | Values for date differ: '2022-08-08T15:11:35+00:00' vs '2023-01-15' |
| Information | StructureDefinition.publisher | Values for publisher differ: 'HL7 International - Patient Care Work Group' vs 'HL7 International / Payer/Provider Information Exchange Work Group' |
| Information | StructureDefinition.comment | Values for comment differ: 'fullUrl might not be [unique in the context of a resource](http://hl7.org/fhir/R4/bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](http://hl7.org/fhir/R4/references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](http://hl7.org/fhir/R4/references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id. Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).' vs 'fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](http://hl7.org/fhir/R4/references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](http://hl7.org/fhir/R4/references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id. Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).' |
| Information | StructureDefinition.short | Values for short differ: 'Digital Signature' vs 'JWS Digital Signature' |
| Information | StructureDefinition.definition | Values for definition differ: 'Digital Signature - base64 encoded. XML-DSig or a JWT.' vs 'A JWS digital signature along with supporting context.' |
| Information | StructureDefinition.comment | Values for comment differ: '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.' |
| 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 |
|
| 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 |
|
| 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 | HL7 International / Payer/Provider Information Exchange 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.1.0-preview |
|
| Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | R Type | R Description & Constraints | Comments | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
 Bundle | C | 0..* | Bundle | Contains a collection of resources bdl-1: total only when a search or history bdl-2: entry.search only when a search bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) bdl-9: A document must have an identifier with a system and a value bdl-10: A document must have a date bdl-11: A document must have a Composition as the first resource bdl-12: A message must have a MessageHeader as the first resource 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 bdl-1: total only when a search or history bdl-2: entry.search only when a search bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) bdl-9: A document must have an identifier with a system and a value bdl-10: A document must have a date bdl-11: A document must have a Composition as the first resource bdl-12: A message must have a MessageHeader as the first resource | |||||||||
 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.
| 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
| |||||||||||
| 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 bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference 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 bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference 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 cdex-13: The signature element must have either reference to the signer or the signer's identifier and name. | |||||||||
| id | 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 |
| |||||||||||||
| 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. |
| ||||||||||||
| when | SΣ | 1..1 | instant | When the signature was created |
| ||||||||||||
| who | SΣ | 1..1 | Reference(US Core Practitioner Profile(3.1.0) S | US Core Organization Profile(3.1.0) S | US Core PractitionerRole Profile(3.1.0)) | Organization or practitioner who signed the Bundle |
| ||||||||||||
| onBehalfOf | Σ | 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. |
| |||||||||||||
| sigFormat | 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 |
| ||||||||||||
| Documentation for this format | |||||||||||||||||