cdex-digital-signature
type: StructureDefinition
node role: treeRoot
id:
  v: cdex-digital-signature
text:
  status:
    v: extensions
  div: Generated Narrative: StructureDefinition cdex-digital-signature Name Flags Card. Type Description & Constraints<img src="[binary]" alt="doco" style="background-color: inherit"/> <a href="StructureDefinition-cdex-digital-signature-definitions.html#Signature" title="A JWS digital signature along with supporting context. This Signature DataType profile enforces the various elements of digital signatures documented in Digital Signature Rules and Guidance For CDEX Bundle and QuestionnaireResponse](https://hl7.org/fhir/us/davinci-cdex/signatures.html#digital-signature-rules-and-guidance-for-cdex-bundle-and-questionnaireresponse).">Signature 0..* Signature CDex Bundle and QuestionnaireResponse signature #xD; Slices for type S 1..* Coding Indication of the reason the entity signed the object(s) Slice: Unordered, Open by value:$this #xD; type:verify S 1..1 Coding Verification Signature Required Pattern: At least the following #xD; system 1..1 uri Identity of the terminology system Fixed Value: urn:iso-astm:E1762-95:2013 #xD; code 1..1 code Symbol in syntax defined by the system Fixed Value: 1.2.840.10065.1.12.1.5 #xD; display 1..1 string Representation defined by the system Fixed Value: Verification Signature #xD; when S 1..1 instant When the signature was created #xD; who S 1..1 Reference(US Core Practitioner Profile(3.1.1) S | US Core Practitioner Profile(6.1.0) S | US Core Practitioner Profile(7.0.0) S | HRex Organization Profile(1.1.0) S | HRex PractitionerRole Profile(1.1.0)) Organization or practitioner who signed the Bundle #xD; identifier S 1..1 Identifier NPI or US Tax ID #xD; system S 0..1 uri The namespace for the identifier value #xD; value S 1..1 string The value that is unique #xD; targetFormat S 1..1 code Canonicalization method Fixed Value: application/fhir+json;canonicalization=http://hl7.org/fhir/canonicalization/json#document #xD; sigFormat S 1..1 code The JWS mime type Fixed Value: application/jose #xD; data S 1..1 base64Binary base64 encoded JSON Web Sig…
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-wg
  value: code
    v: claims
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm
  value: integer
    v: 2
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom
      value: canonical
        v: http://hl7.org/fhir/us/davinci-cdex/ImplementationGuide/hl7.fhir.us.davinci-cdex
        link: http://hl7.org/fhir/us/davinci-cdex/ImplementationGuide/hl7.fhir.us.davinci-cdex
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
  value: code
    v: trial-use
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom
      value: canonical
        v: http://hl7.org/fhir/us/davinci-cdex/ImplementationGuide/hl7.fhir.us.davinci-cdex
        link: http://hl7.org/fhir/us/davinci-cdex/ImplementationGuide/hl7.fhir.us.davinci-cdex
url:
  v: http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-digital-signature
identifier:
  system:
    v: urn:ietf:rfc:3986
  value:
    v: urn:oid:2.16.840.1.113883.4.642.40.21.42.1
version:
  v: 2.1.0
name:
  v: CDexDigitalSignature
title:
  v: CDex Digital Signature Profile
status:
  v: active
date:
  v: 2023-01-15
publisher:
  v: HL7 International / Payer/Provider Information Exchange Work Group
contact:
  name:
    v: HL7 International / Payer/Provider Information Exchange Work Group
  telecom:
    system:
      v: url
    value:
      v: http://www.hl7.org/Special/committees/claims
  telecom:
    system:
      v: email
description:
  v: This Signature DataType profile enforces the various elements of digital signatures documented in [Digital Signature Rules and Guidance For CDEX Bundle and QuestionnaireResponse](https://hl7.org/fhir/us/davinci-cdex/signatures.html#digital-signature-rules-and-guidance-for-cdex-bundle-and-questionnaireresponse).
jurisdiction:
  coding:
    system:
      v: urn:iso:std:iso:3166
    code:
      v: US
copyright:
  v: Used by permission of HL7 International all rights reserved Creative Commons License
fhir version:
  v: 4.0.1
mapping:
  identity:
    v: rim
  uri:
    v: http://hl7.org/v3
  name:
    v: RIM Mapping
kind:
  v: complex-type
abstract:
  v: false
type:
  v: Signature
base definition:
  v: http://hl7.org/fhir/StructureDefinition/Signature
  link: http://hl7.org/fhir/StructureDefinition/Signature
derivation:
  v: constraint
snapshot:
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version
    value: string
      v: 4.0.1
  element:
    id:
      v: Signature
    path:
      v: Signature
    short:
      v: CDex Bundle and QuestionnaireResponse signature
    definition:
      v: A JWS digital signature along with supporting context. This Signature DataType profile enforces the various elements of digital signatures documented in Digital Signature Rules and Guidance For CDEX Bundle and QuestionnaireResponse](https://hl7.org/fhir/us/davinci-cdex/signatures.html#digital-signature-rules-and-guidance-for-cdex-bundle-and-questionnaireresponse).
    comment:
      v: 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.
    min:
      v: 0
    max:
      v: *
    base:
      path:
        v: Signature
      min:
        v: 0
      max:
        v: *
    condition:
      v: ele-1
    constraint:
      key:
        v: ele-1
      severity:
        v: error
      human:
        v: All FHIR elements must have a @value or children
      expression:
        v: hasValue() or (children().count() > id.count())
      xpath:
        v: @value|f:*|h:div
      source:
        v: http://hl7.org/fhir/StructureDefinition/Element
        link: http://hl7.org/fhir/StructureDefinition/Element
    is modifier:
      v: false
    mapping:
      identity:
        v: rim
      map:
        v: n/a
    mapping:
      identity:
        v: rim
      map:
        v: N/A
  element:
    id:
      v: Signature.id
    path:
      v: Signature.id
    representation:
      v: xmlAttr
    short:
      v: Unique id for inter-element referencing
    definition:
      v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
    min:
      v: 0
    max:
      v: 1
    base:
      path:
        v: Element.id
      min:
        v: 0
      max:
        v: 1
    type:
      extension:
        value: url
      code:
        v: http://hl7.org/fhirpath/System.String
    is modifier:
      v: false
    is summary:
      v: false
    mapping:
      identity:
        v: rim
      map:
        v: n/a
  element:
    id:
      v: Signature.extension
    path:
      v: Signature.extension
    slicing:
      description:
        v: Extensions are always sliced by (at least) url
      rules:
        v: open
    short:
      v: Additional content defined by implementations
    definition:
      v: 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.
    comment:
      v: 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.

url
v: string

v: value

v: url

v: extensions

v: user content

v: 0

v: *

path:
  v: Element.extension
min:
  v: 0
max:
  v: *

code:
  v: Extension

key:
  v: ele-1
severity:
  v: error
human:
  v: All FHIR elements must have a @value or children
expression:
  v: hasValue() or (children().count() > id.count())
xpath:
  v: @value|f:*|h:div
source:
  v: http://hl7.org/fhir/StructureDefinition/Element
  link: http://hl7.org/fhir/StructureDefinition/Element

key:
  v: ext-1
severity:
  v: error
human:
  v: Must have either extensions or value[x], not both
expression:
  v: extension.exists() != value.exists()
xpath:
  v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
source:
  v: http://hl7.org/fhir/StructureDefinition/Extension
  link: http://hl7.org/fhir/StructureDefinition/Extension

v: false

v: false

identity:
  v: rim
map:
  v: n/a

id:
  v: Signature.type
path:
  v: Signature.type
slicing:
  discriminator:
    type:
      v: value
    path:
      v: $this
  rules:
    v: open
short:
  v: Indication of the reason the entity signed the object(s)
definition:
  v: 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.
comment:
  v: Examples include attesting to: authorship, correct transcription, and witness of specific event. Also known as a "Commitment Type Indication".
min:
  v: 1
max:
  v: *
base:
  path:
    v: Signature.type
  min:
    v: 1
  max:
    v: *
type:
  code:
    v: Coding
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value: string
      v: SignatureType
  strength:
    v: preferred
  description:
    v: An indication of the reason that an entity signed the object.
  value set:
    v: http://hl7.org/fhir/ValueSet/signature-type
    link: http://hl7.org/fhir/ValueSet/signature-type

id:
  v: Signature.type:verify
path:
  v: Signature.type
slice name:
  v: verify
short:
  v: Verification Signature
definition:
  v: 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.
comment:
  v: Examples include attesting to: authorship, correct transcription, and witness of specific event. Also known as a "Commitment Type Indication".
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Signature.type
  min:
    v: 1
  max:
    v: *
type:
  code:
    v: Coding
pattern: Coding
  system:
    v: urn:iso-astm:E1762-95:2013
  code:
    v: 1.2.840.10065.1.12.1.5
  display:
    v: Verification Signature
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value: string
      v: SignatureType
  strength:
    v: preferred
  description:
    v: An indication of the reason that an entity signed the object.
  value set:
    v: http://hl7.org/fhir/ValueSet/signature-type
    link: http://hl7.org/fhir/ValueSet/signature-type

id:
  v: Signature.when
path:
  v: Signature.when
short:
  v: When the signature was created
definition:
  v: When the digital signature was signed.
comment:
  v: This should agree with the information in the signature.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Signature.when
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: instant
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true

id:
  v: Signature.who
path:
  v: Signature.who
short:
  v: Organization or practitioner who signed the Bundle
definition:
  v: A reference to an application-usable description of the identity that signed (e.g. the signature used their private key).
comment:
  v: This should agree with the information in the signature.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Signature.who
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: Reference
  target profile:
    v: http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner|3.1.1
    link: 3.1
    link: .1
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/elementdefinition-type-must-support
      value: boolean
        v: true
  target profile:
    v: http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner|6.1.0
    link: 6.1
    link: .0
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/elementdefinition-type-must-support
      value: boolean
        v: true
  target profile:
    v: http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner|7.0.0
    link: 7.0
    link: .0
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/elementdefinition-type-must-support
      value: boolean
        v: true
  target profile:
    v: http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/hrex-organization
    link: http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/hrex-organization
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/elementdefinition-type-must-support
      value: boolean
        v: true
  target profile:
    v: http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/hrex-practitionerrole
    link: http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/hrex-practitionerrole
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/elementdefinition-type-must-support
      value: boolean
        v: false
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true

id:
  v: Signature.who.id
path:
  v: Signature.who.id
representation:
  v: xmlAttr
short:
  v: Unique id for inter-element referencing
definition:
  v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
    value: url
      v: string
  code:
    v: http://hl7.org/fhirpath/System.String
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Signature.who.extension
path:
  v: Signature.who.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
short:
  v: Additional content defined by implementations
definition:
  v: 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.
comment:
  v: 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.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Signature.who.reference
path:
  v: Signature.who.reference
short:
  v: Literal reference, Relative, internal or absolute URL
definition:
  v: A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
comment:
  v: Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Reference.reference
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
condition:
  v: ref-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Signature.who.type
path:
  v: Signature.who.type
short:
  v: Type the reference refers to (e.g. "Patient")
definition:
  v: The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
comment:
  v: This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Reference.type
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: uri
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value: string
      v: FHIRResourceTypeExt
  strength:
    v: extensible
  description:
    v: Aa resource (or, for logical models, the URI of the logical model).
  value set:
    v: http://hl7.org/fhir/ValueSet/resource-types
    link: http://hl7.org/fhir/ValueSet/resource-types
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Signature.who.identifier
path:
  v: Signature.who.identifier
short:
  v: NPI or US Tax ID
definition:
  v: NPI or Tax ID representing the Provider or Organization
comment:
  v: When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Reference.identifier
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Identifier
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: .identifier

id:
  v: Signature.who.identifier.id
path:
  v: Signature.who.identifier.id
representation:
  v: xmlAttr
short:
  v: Unique id for inter-element referencing
definition:
  v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
    value: url
      v: string
  code:
    v: http://hl7.org/fhirpath/System.String
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Signature.who.identifier.extension
path:
  v: Signature.who.identifier.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
short:
  v: Additional content defined by implementations
definition:
  v: 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.
comment:
  v: 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.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Signature.who.identifier.use
path:
  v: Signature.who.identifier.use
short:
  v: usual | official | temp | secondary | old (If known)
definition:
  v: The purpose of this identifier.
comment:
  v: Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
requirements:
  v: Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Identifier.use
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: true
is modifier reason:
  v: This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value: string
      v: IdentifierUse
  strength:
    v: required
  description:
    v: Identifies the purpose for this identifier, if known .
  value set:
    v: http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
    link: 4.0
    link: .1
mapping:
  identity:
    v: v2
  map:
    v: N/A
mapping:
  identity:
    v: rim
  map:
    v: Role.code or implied by context

id:
  v: Signature.who.identifier.type
path:
  v: Signature.who.identifier.type
short:
  v: Description of identifier
definition:
  v: A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
comment:
  v: This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
requirements:
  v: Allows users to make use of identifiers when the identifier system is not known.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Identifier.type
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: CodeableConcept
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value: string
      v: IdentifierType
  strength:
    v: extensible
  description:
    v: A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
  value set:
    v: http://hl7.org/fhir/ValueSet/identifier-type
    link: http://hl7.org/fhir/ValueSet/identifier-type
mapping:
  identity:
    v: v2
  map:
    v: CX.5
mapping:
  identity:
    v: rim
  map:
    v: Role.code or implied by context

id:
  v: Signature.who.identifier.system
path:
  v: Signature.who.identifier.system
short:
  v: The namespace for the identifier value
definition:
  v: Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
comment:
  v: Identifier.system is always case sensitive.
requirements:
  v: There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Identifier.system
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: uri
example:
  label:
    v: General
  value: uri
    v: http://www.acme.com/identifiers/patient
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: CX.4 / EI-2-4
mapping:
  identity:
    v: rim
  map:
    v: II.root or Role.id.root
mapping:
  identity:
    v: servd
  map:
    v: ./IdentifierType

id:
  v: Signature.who.identifier.value
path:
  v: Signature.who.identifier.value
short:
  v: The value that is unique
definition:
  v: The portion of the identifier typically relevant to the user and which is unique within the context of the system.
comment:
  v: If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](http://hl7.org/fhir/R4/extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Identifier.value
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
example:
  label:
    v: General
  value: string
    v: 123456
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: CX.1 / EI.1
mapping:
  identity:
    v: rim
  map:
    v: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
mapping:
  identity:
    v: servd
  map:
    v: ./Value

id:
  v: Signature.who.identifier.period
path:
  v: Signature.who.identifier.period
short:
  v: Time period when id is/was valid for use
definition:
  v: Time period during which identifier is/was valid for use.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Identifier.period
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Period
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: CX.7 + CX.8
mapping:
  identity:
    v: rim
  map:
    v: Role.effectiveTime or implied by context
mapping:
  identity:
    v: servd
  map:
    v: ./StartDate and ./EndDate

id:
  v: Signature.who.identifier.assigner
path:
  v: Signature.who.identifier.assigner
short:
  v: Organization that issued id (may be just text)
definition:
  v: Organization that issued/manages the identifier.
comment:
  v: The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Identifier.assigner
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Organization
    link: http://hl7.org/fhir/StructureDefinition/Organization
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: CX.4 / (CX.4,CX.9,CX.10)
mapping:
  identity:
    v: rim
  map:
    v: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
mapping:
  identity:
    v: servd
  map:
    v: ./IdentifierIssuingAuthority

id:
  v: Signature.who.display
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable
  value: boolean
    v: true
path:
  v: Signature.who.display
short:
  v: Text alternative for the resource
definition:
  v: Plain text narrative that identifies the resource in addition to the resource reference.
comment:
  v: This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Reference.display
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Signature.onBehalfOf
path:
  v: Signature.onBehalfOf
short:
  v: The party represented
definition:
  v: A reference to an application-usable description of the identity that is represented by the signature.
comment:
  v: The party that can't sign. For example a child.
requirements:
  v: used when the signature is on behalf of a non-signer.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Signature.onBehalfOf
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Practitioner
    link: http://hl7.org/fhir/StructureDefinition/Practitioner
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/PractitionerRole
    link: http://hl7.org/fhir/StructureDefinition/PractitionerRole
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/RelatedPerson
    link: http://hl7.org/fhir/StructureDefinition/RelatedPerson
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Patient
    link: http://hl7.org/fhir/StructureDefinition/Patient
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Device
    link: http://hl7.org/fhir/StructureDefinition/Device
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Organization
    link: http://hl7.org/fhir/StructureDefinition/Organization
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true

id:
  v: Signature.targetFormat
path:
  v: Signature.targetFormat
short:
  v: Canonicalization method
definition:
  v: A mime type that indicates the technical format of the target resources signed by the signature.
comment:
  v: "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.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Signature.targetFormat
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
fixed: code
  v: application/fhir+json;canonicalization=http://hl7.org/fhir/canonicalization/json#document
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: false
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value: string
      v: MimeType
  strength:
    v: required
  description:
    v: The mime type of an attachment. Any valid mime type is allowed.
  value set:
    v: http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
    link: 4.0
    link: .1

id:
  v: Signature.sigFormat
path:
  v: Signature.sigFormat
short:
  v: The JWS mime type
definition:
  v: 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.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Signature.sigFormat
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
fixed: code
  v: application/jose
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: false
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value: string
      v: MimeType
  strength:
    v: required
  description:
    v: The mime type of an attachment. Any valid mime type is allowed.
  value set:
    v: http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
    link: 4.0
    link: .1

id:
  v: Signature.data
path:
  v: Signature.data
short:
  v: base64 encoded JSON Web Signature (JWS)
definition:
  v: The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty.
comment:
  v: 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.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Signature.data
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: base64Binary
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: false

element:
  id:
    v: Signature
  path:
    v: Signature
  short:
    v: CDex Bundle and QuestionnaireResponse signature
  definition:
    v: A JWS digital signature along with supporting context. This Signature DataType profile enforces the various elements of digital signatures documented in Digital Signature Rules and Guidance For CDEX Bundle and QuestionnaireResponse](https://hl7.org/fhir/us/davinci-cdex/signatures.html#digital-signature-rules-and-guidance-for-cdex-bundle-and-questionnaireresponse).
element:
  id:
    v: Signature.type
  path:
    v: Signature.type
  slicing:
    discriminator:
      type:
        v: value
      path:
        v: $this
    rules:
      v: open
  min:
    v: 1
  must support:
    v: true
element:
  id:
    v: Signature.type:verify
  path:
    v: Signature.type
  slice name:
    v: verify
  short:
    v: Verification Signature
  min:
    v: 1
  max:
    v: 1
  pattern: Coding
    system:
      v: urn:iso-astm:E1762-95:2013
    code:
      v: 1.2.840.10065.1.12.1.5
    display:
      v: Verification Signature
  must support:
    v: true
element:
  id:
    v: Signature.when
  path:
    v: Signature.when
  must support:
    v: true
element:
  id:
    v: Signature.who
  path:
    v: Signature.who
  short:
    v: Organization or practitioner who signed the Bundle
  type:
    code:
      v: Reference
    target profile:
      v: http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner|3.1.1
      link: 3.1
      link: .1
      extension:
        value: boolean
    target profile:
      v: http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner|6.1.0
      link: 6.1
      link: .0
      extension:
        value: boolean
    target profile:
      v: http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner|7.0.0
      link: 7.0
      link: .0
      extension:
        value: boolean
    target profile:
      v: http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/hrex-organization
      link: http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/hrex-organization
      extension:
        value: boolean
    target profile:
      v: http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/hrex-practitionerrole
      link: http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/hrex-practitionerrole
      extension:
        value: boolean
  must support:
    v: true
element:
  id:
    v: Signature.who.identifier
  path:
    v: Signature.who.identifier
  short:
    v: NPI or US Tax ID
  definition:
    v: NPI or Tax ID representing the Provider or Organization
  min:
    v: 1
  must support:
    v: true
element:
  id:
    v: Signature.who.identifier.system
  path:
    v: Signature.who.identifier.system
  min:
    v: 0
  must support:
    v: true
element:
  id:
    v: Signature.who.identifier.value
  path:
    v: Signature.who.identifier.value
  min:
    v: 1
  must support:
    v: true
element:
  id:
    v: Signature.targetFormat
  path:
    v: Signature.targetFormat
  short:
    v: Canonicalization method
  min:
    v: 1
  fixed: code
    v: application/fhir+json;canonicalization=http://hl7.org/fhir/canonicalization/json#document
  must support:
    v: true
element:
  id:
    v: Signature.sigFormat
  path:
    v: Signature.sigFormat
  short:
    v: The JWS mime type
  min:
    v: 1
  fixed: code
    v: application/jose
  must support:
    v: true
element:
  id:
    v: Signature.data
  path:
    v: Signature.data
  short:
    v: base64 encoded JSON Web Signature (JWS)
  min:
    v: 1
  must support:
    v: true

boolean
v: true

boolean
v: true

boolean
v: true

boolean
v: true

boolean
v: false