Da Vinci Clinical Data Exchange (CDex)
2.0.0 - STU2
Da Vinci Clinical Data Exchange (CDex)
2.0.0 - STU2
This page is part of the Da Vinci Clinical Documentation Exchange (v2.0.0: STU2) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions 
| Official URL: http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-signature | Version: 2.0.0 | |||
| Standards status: Trial-use | Maturity Level: 2 | Computable Name: CDexSignature | ||
Copyright/Legal: Used by permission of HL7 International all rights reserved Creative Commons License |
||||
This Signature DataType profile enforces the various elements of signature documented in the CDex guide. It adds the following mandatory (min=1) constraints:
In addition, the following mandatory (min=1) element is inherited from the base standard:
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Signature
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Signature | C | 0..* | Signature | JWS Digital Signature cdex-13: The signature element must have either reference to the signer or the signer's identifier and name. |
  Slices for type | S | 1..* | Coding | Indication of the reason the entity signed the object(s) Slice: Unordered, Open by pattern:$this |
   type:verify | S | 1..1 | Coding | Verification Signature Required Pattern: At least the following |
   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 | |
| when | S | 1..1 | instant | When the signature was created |
 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 |
| reference | SC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| identifier | SC | 0..1 | Identifier | NPI or US Tax ID |
| type | S | 1..1 | CodeableConcept | Description of identifier Binding: CDex Identifier Types Value Set (required) |
 value | S | 1..1 | string | The value that is unique |
| display | SC | 0..1 | string | Text alternative for the resource |
| data | S | 1..1 | base64Binary | base64 encoded JWS-Signature |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Signature.who.identifier.type | required | CDexIdentifierTypes |
| Id | Grade | Path(s) | Details | Requirements |
| cdex-13 | error | Signature | The signature element must have either reference to the signer or the signer's identifier and name. : who.reference.exists() or (who.identifier.exists() and who.display.exists()) |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Signature | C | 0..* | Signature | JWS Digital Signature cdex-13: The signature element must have either reference to the signer or the signer's identifier and name. |
| Slices for type | SΣ | 1..* | Coding | Indication of the reason the entity signed the object(s) Slice: Unordered, Open by pattern:$this Binding: SignatureTypeCodes (preferred): An indication of the reason that an entity signed the object. |
| type:verify | SΣ | 1..1 | Coding | Verification Signature Binding: SignatureTypeCodes (preferred): An indication of the reason that an entity signed the object. Required Pattern: At least the following |
| 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 | |
 when | SΣ | 1..1 | instant | When the signature was created |
| who | SΣ | 1..1 | Reference(US Core Practitioner Profile | US Core Organization Profile) | Organization or practitioner who signed the Bundle |
| reference | SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
 identifier | SΣC | 0..1 | Identifier | NPI or US Tax ID |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type | SΣ | 1..1 | CodeableConcept | Description of identifier Binding: CDex Identifier Types Value Set (required) |
| value | SΣ | 1..1 | string | The value that is unique Example General: 123456 |
| display | SΣC | 0..1 | string | Text alternative for the resource |
| data | S | 1..1 | base64Binary | base64 encoded JWS-Signature |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Signature.type | preferred | SignatureTypeCodes |
| Signature.type:verify | preferred | Pattern: 1.2.840.10065.1.12.1.5("Verification Signature") |
| Signature.who.identifier.use | required | IdentifierUse |
| Signature.who.identifier.type | required | CDexIdentifierTypes |
| Id | Grade | Path(s) | Details | Requirements |
| cdex-13 | error | Signature | The signature element must have either reference to the signer or the signer's identifier and name. : who.reference.exists() or (who.identifier.exists() and who.display.exists()) |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Signature | C | 0..* | Signature | 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 | |
 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: SignatureTypeCodes (preferred): An indication of the reason that an entity signed the object. |
| type:verify | SΣ | 1..1 | Coding | Verification Signature Binding: SignatureTypeCodes (preferred): An indication of the reason that an entity signed the object. Required Pattern: At least the following |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 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..1 | 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..1 | boolean | If this coding was chosen directly by the user | |
| when | SΣ | 1..1 | instant | When the signature was created |
| 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 |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 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 |
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). |
| identifier | SΣC | 0..1 | Identifier | NPI or US Tax ID |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 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: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type | SΣ | 1..1 | CodeableConcept | Description of identifier Binding: CDex Identifier Types Value Set (required) |
| system | Σ | 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 |
| period | Σ | 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) |
| display | SΣC | 0..1 | string | Text alternative for the resource |
| 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: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. | |
| sigFormat | 0..1 | code | The technical format of the signature Binding: Mime Types (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 | ||||
| Path | Conformance | ValueSet / Code |
| Signature.type | preferred | SignatureTypeCodes |
| Signature.type:verify | preferred | Pattern: 1.2.840.10065.1.12.1.5("Verification Signature") |
| Signature.who.type | extensible | ResourceType |
| Signature.who.identifier.use | required | IdentifierUse |
| Signature.who.identifier.type | required | CDexIdentifierTypes |
| Signature.targetFormat | required | Mime Types (a valid code from urn:ietf:bcp:13) |
| Signature.sigFormat | required | Mime Types (a valid code from urn:ietf:bcp:13) |
This structure is derived from Signature
Summary
Mandatory: 3 elements (2 nested mandatory elements)
Must-Support: 10 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 2
Differential View
This structure is derived from Signature
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Signature | C | 0..* | Signature | JWS Digital Signature cdex-13: The signature element must have either reference to the signer or the signer's identifier and name. |
| Slices for type | S | 1..* | Coding | Indication of the reason the entity signed the object(s) Slice: Unordered, Open by pattern:$this |
| type:verify | S | 1..1 | Coding | Verification Signature Required Pattern: At least the following |
| 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 | |
| when | S | 1..1 | instant | When the signature was created |
| 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 |
| reference | SC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| identifier | SC | 0..1 | Identifier | NPI or US Tax ID |
| type | S | 1..1 | CodeableConcept | Description of identifier Binding: CDex Identifier Types Value Set (required) |
| value | S | 1..1 | string | The value that is unique |
| display | SC | 0..1 | string | Text alternative for the resource |
| data | S | 1..1 | base64Binary | base64 encoded JWS-Signature |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Signature.who.identifier.type | required | CDexIdentifierTypes |
| Id | Grade | Path(s) | Details | Requirements |
| cdex-13 | error | Signature | The signature element must have either reference to the signer or the signer's identifier and name. : who.reference.exists() or (who.identifier.exists() and who.display.exists()) |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Signature | C | 0..* | Signature | JWS Digital Signature cdex-13: The signature element must have either reference to the signer or the signer's identifier and name. |
| Slices for type | SΣ | 1..* | Coding | Indication of the reason the entity signed the object(s) Slice: Unordered, Open by pattern:$this Binding: SignatureTypeCodes (preferred): An indication of the reason that an entity signed the object. |
| type:verify | SΣ | 1..1 | Coding | Verification Signature Binding: SignatureTypeCodes (preferred): An indication of the reason that an entity signed the object. Required Pattern: At least the following |
| 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 | |
| when | SΣ | 1..1 | instant | When the signature was created |
| who | SΣ | 1..1 | Reference(US Core Practitioner Profile | US Core Organization Profile) | Organization or practitioner who signed the Bundle |
| reference | SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| identifier | SΣC | 0..1 | Identifier | NPI or US Tax ID |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type | SΣ | 1..1 | CodeableConcept | Description of identifier Binding: CDex Identifier Types Value Set (required) |
| value | SΣ | 1..1 | string | The value that is unique Example General: 123456 |
| display | SΣC | 0..1 | string | Text alternative for the resource |
| data | S | 1..1 | base64Binary | base64 encoded JWS-Signature |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Signature.type | preferred | SignatureTypeCodes |
| Signature.type:verify | preferred | Pattern: 1.2.840.10065.1.12.1.5("Verification Signature") |
| Signature.who.identifier.use | required | IdentifierUse |
| Signature.who.identifier.type | required | CDexIdentifierTypes |
| Id | Grade | Path(s) | Details | Requirements |
| cdex-13 | error | Signature | The signature element must have either reference to the signer or the signer's identifier and name. : who.reference.exists() or (who.identifier.exists() and who.display.exists()) |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Signature | C | 0..* | Signature | 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 | |
| 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: SignatureTypeCodes (preferred): An indication of the reason that an entity signed the object. |
| type:verify | SΣ | 1..1 | Coding | Verification Signature Binding: SignatureTypeCodes (preferred): An indication of the reason that an entity signed the object. Required Pattern: At least the following |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 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..1 | 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..1 | boolean | If this coding was chosen directly by the user | |
| when | SΣ | 1..1 | instant | When the signature was created |
| 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 |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 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 |
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). |
| identifier | SΣC | 0..1 | Identifier | NPI or US Tax ID |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 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: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type | SΣ | 1..1 | CodeableConcept | Description of identifier Binding: CDex Identifier Types Value Set (required) |
| system | Σ | 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 |
| period | Σ | 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) |
| display | SΣC | 0..1 | string | Text alternative for the resource |
| 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: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. | |
| sigFormat | 0..1 | code | The technical format of the signature Binding: Mime Types (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 | ||||
| Path | Conformance | ValueSet / Code |
| Signature.type | preferred | SignatureTypeCodes |
| Signature.type:verify | preferred | Pattern: 1.2.840.10065.1.12.1.5("Verification Signature") |
| Signature.who.type | extensible | ResourceType |
| Signature.who.identifier.use | required | IdentifierUse |
| Signature.who.identifier.type | required | CDexIdentifierTypes |
| Signature.targetFormat | required | Mime Types (a valid code from urn:ietf:bcp:13) |
| Signature.sigFormat | required | Mime Types (a valid code from urn:ietf:bcp:13) |
This structure is derived from Signature
Summary
Mandatory: 3 elements (2 nested mandatory elements)
Must-Support: 10 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 2
Other representations of profile: CSV, Excel, Schematron
IG © 2023+ HL7 International - Patient Care Work Group. Package hl7.fhir.us.davinci-cdex#2.0.0 based on FHIR 4.0.1. Generated 2023-03-22
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change