payment-annotation
type: StructureDefinition
node role: treeRoot
id:
  v: payment-annotation
text:
  status:
    v: extensions
  div:
    v: Generated Narrative: StructureDefinition payment-annotation Name Flags Card. Type Description & Constraints Extension 0..* Extension Payment Annotation #xD; extension 0..0 Extension #xD; url 1..1 uri "https://alexapi.medtechglobal.com/fhir/StructureDefinition/payment-annotation" #xD; value[x] 1..1 Attachment Value of extension #xD; contentType 0..1 code Mime type of the content, with charset etc. Fixed Value: application/rtf #xD; data 1..1 base64Binary Data inline, base64ed #xD; Documentation for this format
url:
  v: https://alexapi.medtechglobal.com/fhir/StructureDefinition/payment-annotation
  l: payment-annotation
version:
  v: 0.0.1
name:
  v: PaymentAnnotation
title:
  v: Payment Annotation
status:
  v: draft
date:
  v: 2026-04-17T04:42:10+00:00
publisher:
  v: Medtech Global
contact:
  name:
    v: Medtech Global
  telecom:
    system:
      v: url
    value:
      v: https://medtechglobal.com
  telecom:
    system:
      v: email
contact:
  name:
    v: Medtech Support
  telecom:
    system:
      v: email
    use:
      v: work
description:
  v: RTF annotation encoded as base64.
jurisdiction:
  coding:
    system:
      v: http://unstats.un.org/unsd/methods/m49/m49.htm
      l: m49.htm
    code:
      v: 001
    display:
      v: World
fhir version:
  v: 4.0.1
mapping:
  identity:
    v: rim
  uri:
    v: http://hl7.org/v3
    l: v3
  name:
    v: RIM Mapping
kind:
  v: complex-type
abstract:
  v: false
context:
  type:
    v: element
  expression:
    v: Element
type:
  v: Extension
  l: Extension
base definition:
  v: http://hl7.org/fhir/StructureDefinition/Extension
  l: Extension
derivation:
  v: constraint
snapshot:
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version
      l: snapshot-base-version
    value: String
      v: 4.0.1
  element:
    id:
      v: Extension
    path:
      v: Extension
    short:
      v: Payment Annotation
    definition:
      v: RTF annotation encoded as base64.
    min:
      v: 0
    max:
      v: *
    base:
      path:
        v: Extension
      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
        l: 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
        l: Extension
    is modifier:
      v: false
  element:
    id:
      v: Extension.id
    path:
      v: Extension.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
        l: System.String
    is modifier:
      v: false
    is summary:
      v: false
    mapping:
      identity:
        v: rim
      map:
        v: n/a
  element:
    id:
      v: Extension.extension
    path:
      v: Extension.extension
    slicing:
      description:
        v: Extensions are always sliced by (at least) url
      rules:
        v: open
    short:
      v: Extension
    definition:
      v: An Extension
    min:
      v: 0
    max:
      v: 0
    base:
      path:
        v: Element.extension
      min:
        v: 0
      max:
        v: *

Url
v: string
l: string

v: value

v: url

code:
  v: Extension
  l: 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
  l: 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
  l: Extension

v: false

v: false

id:
  v: Extension.url
path:
  v: Extension.url
representation:
  v: xmlAttr
short:
  v: identifies the meaning of the extension
definition:
  v: Source of the definition for the extension code - a logical name or a URL.
comment:
  v: The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Extension.url
  min:
    v: 1
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
      l: structuredefinition-fhir-type
    value: Url
      v: uri
      l: uri
  code:
    v: http://hl7.org/fhirpath/System.String
    l: System.String
fixed: Uri
  v: https://alexapi.medtechglobal.com/fhir/StructureDefinition/payment-annotation
  l: payment-annotation
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Extension.value[x]
path:
  v: Extension.value[x]
short:
  v: Value of extension
definition:
  v: Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R4/extensibility.html) for a list).
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Extension.value[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Attachment
    l: Attachment
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
    l: Element
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Extension.value[x].id
path:
  v: Extension.value[x].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
      l: structuredefinition-fhir-type
    value: Url
      v: string
      l: string
  code:
    v: http://hl7.org/fhirpath/System.String
    l: System.String
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Extension.value[x].extension
path:
  v: Extension.value[x].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
    l: 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
    l: 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
    l: Extension
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Extension.value[x].contentType
path:
  v: Extension.value[x].contentType
short:
  v: Mime type of the content, with charset etc.
definition:
  v: Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.
requirements:
  v: Processors of the data need to be able to know how to interpret the data.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Attachment.contentType
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
fixed: Code
  v: application/rtf
example:
  label:
    v: General
  value: Code
    v: text/plain; charset=UTF-8, image/png
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
    l: Element
is modifier:
  v: false
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: 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
    l: http://hl7.org/fhir/ValueSet/mimetypes
mapping:
  identity:
    v: v2
  map:
    v: ED.2+ED.3/RP.2+RP.3. Note conversion may be needed if old style values are being used
mapping:
  identity:
    v: rim
  map:
    v: ./mediaType, ./charset

id:
  v: Extension.value[x].language
path:
  v: Extension.value[x].language
short:
  v: Human language of the content (BCP-47)
definition:
  v: The human language of the content. The value can be any valid value according to BCP 47.
requirements:
  v: Users need to be able to choose between the languages in a set of attachments.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Attachment.language
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
example:
  label:
    v: General
  value: Code
    v: en-AU
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
    l: Element
is modifier:
  v: false
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet
      l: elementdefinition-maxValueSet
    value: Canonical
      v: http://hl7.org/fhir/ValueSet/all-languages
      l: all-languages
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: Language
  strength:
    v: preferred
  description:
    v: A human language.
  value set:
    v: http://hl7.org/fhir/ValueSet/languages|4.0.1
    l: http://hl7.org/fhir/ValueSet/languages
mapping:
  identity:
    v: rim
  map:
    v: ./language

id:
  v: Extension.value[x].data
path:
  v: Extension.value[x].data
short:
  v: Data inline, base64ed
definition:
  v: The actual data of the attachment - a sequence of bytes, base64 encoded.
comment:
  v: The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON.
requirements:
  v: The data needs to able to be transmitted inline.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Attachment.data
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: base64Binary
    l: 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
    l: Element
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: v2
  map:
    v: ED.5
mapping:
  identity:
    v: rim
  map:
    v: ./data

id:
  v: Extension.value[x].url
path:
  v: Extension.value[x].url
short:
  v: Uri where the data can be found
definition:
  v: A location where the data can be accessed.
comment:
  v: If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data.
requirements:
  v: The data needs to be transmitted by reference.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Attachment.url
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: url
    l: url
example:
  label:
    v: General
  value: Url
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
    l: Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: RP.1+RP.2 - if they refer to a URL (see v2.6)
mapping:
  identity:
    v: rim
  map:
    v: ./reference/literal

id:
  v: Extension.value[x].size
path:
  v: Extension.value[x].size
short:
  v: Number of bytes of content (if url provided)
definition:
  v: The number of bytes of data that make up this attachment (before base64 encoding, if that is done).
comment:
  v: The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference.
requirements:
  v: Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Attachment.size
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: unsignedInt
    l: unsignedInt
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
    l: Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A (needs data type R3 proposal)

id:
  v: Extension.value[x].hash
path:
  v: Extension.value[x].hash
short:
  v: Hash of the data (sha-1, base64ed)
definition:
  v: The calculated hash of the data using SHA-1. Represented using base64.
comment:
  v: The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. The hash is not intended to support digital signatures. Where protection against malicious threats a digital signature should be considered, see [Provenance.signature](http://hl7.org/fhir/R4/provenance-definitions.html#Provenance.signature) for mechanism to protect a resource with a digital signature.
requirements:
  v: Included so that applications can verify that the contents of a location have not changed due to technical failures (e.g., storage rot, transport glitch, incorrect version).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Attachment.hash
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: base64Binary
    l: 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
    l: Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: .integrityCheck[parent::ED/integrityCheckAlgorithm="SHA-1"]

id:
  v: Extension.value[x].title
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable
    l: elementdefinition-translatable
  value: Boolean
    v: true
path:
  v: Extension.value[x].title
short:
  v: Label to display in place of the data
definition:
  v: A label or set of text to display in place of the data.
requirements:
  v: Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Attachment.title
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
example:
  label:
    v: General
  value: String
    v: Official Corporate Logo
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
    l: Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: ./title/data

id:
  v: Extension.value[x].creation
path:
  v: Extension.value[x].creation
short:
  v: Date attachment was first created
definition:
  v: The date that the attachment was first created.
requirements:
  v: This is often tracked as an integrity issue for use of the attachment.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Attachment.creation
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: dateTime
    l: dateTime
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
    l: Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A (needs data type R3 proposal)

element:
  id:
    v: Extension
  path:
    v: Extension
  short:
    v: Payment Annotation
  definition:
    v: RTF annotation encoded as base64.
element:
  id:
    v: Extension.extension
  path:
    v: Extension.extension
  max:
    v: 0
element:
  id:
    v: Extension.url
  path:
    v: Extension.url
  fixed: Uri
    v: https://alexapi.medtechglobal.com/fhir/StructureDefinition/payment-annotation
    l: payment-annotation
element:
  id:
    v: Extension.value[x]
  path:
    v: Extension.value[x]
  min:
    v: 1
  type:
    code:
      v: Attachment
      l: Attachment
element:
  id:
    v: Extension.value[x].contentType
  path:
    v: Extension.value[x].contentType
  fixed: Code
    v: application/rtf
element:
  id:
    v: Extension.value[x].data
  path:
    v: Extension.value[x].data
  min:
    v: 1