Private OptionalidentifierPaymentReconciliation.identifier Element
FHIR Specification
IdentifierPrivatetype_PaymentReconciliation.type Element
Private ReadonlyfmFHIR CodeSystem: FmStatus
PrivatestatusPaymentReconciliation.status Element
FHIR Specification
codeCodeSystem Enumeration: FmStatusEnum
Private OptionalkindPaymentReconciliation.kind Element
Private OptionalperiodPaymentReconciliation.period Element
FHIR Specification
PeriodPrivatecreatedPaymentReconciliation.created Element
Private OptionalentererPaymentReconciliation.enterer Element
Private OptionalissuerPaymentReconciliation.issuerType Element
FHIR Specification
CodeableConceptPrivate OptionalpaymentPaymentReconciliation.paymentIssuer Element
FHIR Specification
Reference
Private OptionalrequestPaymentReconciliation.request Element
FHIR Specification
Reference
Private OptionalrequestorPaymentReconciliation.requestor Element
Private ReadonlypaymentFHIR CodeSystem: PaymentOutcome
Private OptionaloutcomePaymentReconciliation.outcome Element
FHIR Specification
codeCodeSystem Enumeration: PaymentOutcomeEnum
Private OptionaldispositionPaymentReconciliation.disposition Element
PrivatedatePaymentReconciliation.date Element
Private OptionallocationPaymentReconciliation.location Element
FHIR Specification
Reference
Private OptionalmethodPaymentReconciliation.method Element
Private OptionalcardPaymentReconciliation.cardBrand Element
Private OptionalaccountPaymentReconciliation.accountNumber Element
Private OptionalexpirationPaymentReconciliation.expirationDate Element
Private OptionalprocessorPaymentReconciliation.processor Element
Private OptionalreferencePaymentReconciliation.referenceNumber Element
Private OptionalauthorizationPaymentReconciliation.authorization Element
Private OptionaltenderedPaymentReconciliation.tenderedAmount Element
FHIR Specification
MoneyPrivate OptionalreturnedPaymentReconciliation.returnedAmount Element
PrivateamountPaymentReconciliation.amount Element
Private OptionalpaymentPaymentReconciliation.paymentIdentifier Element
FHIR Specification
IdentifierPrivate OptionalallocationPaymentReconciliation.allocation Element
FHIR Specification
BackboneElementPrivate OptionalformPaymentReconciliation.formCode Element
FHIR Specification
CodeableConceptPrivate OptionalprocessPaymentReconciliation.processNote Element
FHIR Specification
BackboneElementStaticparseParse the provided PaymentReconciliation JSON to instantiate the PaymentReconciliation data model.
JSON representing FHIR PaymentReconciliation
OptionaloptSourceField: stringOptional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to PaymentReconciliation
PaymentReconciliation data model or undefined for PaymentReconciliation
JsonError if the provided JSON is not a valid JSON object
the identifier property value as a Identifier array
Assigns the provided Identifier array value to the identifier property.
the identifier array value
this
InvalidTypeError for invalid data types
Add the provided Identifier value to the identifier array property.
the identifier value
this
InvalidTypeError for invalid data types
true if the identifier property exists and has a value; false otherwise
the type_ property value as a CodeableConcept object if defined; else an empty CodeableConcept object
Assigns the provided CodeableConcept object value to the type_ property.
the type_ object value
this
InvalidTypeError for invalid data types
true if the type_ property exists and has a value; false otherwise
the status property value as a EnumCodeType if defined; else null
CodeSystem Enumeration: FmStatusEnum
Assigns the provided EnumCodeType value to the status property.
the status value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: FmStatusEnum
true if the status property exists and has a value; false otherwise
the status property value as a CodeType if defined; else null
CodeSystem Enumeration: FmStatusEnum
Assigns the provided PrimitiveType value to the status property.
the status value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: FmStatusEnum
true if the status property exists and has a value; false otherwise
the status property value as a fhirCode if defined; else null
CodeSystem Enumeration: FmStatusEnum
Assigns the provided primitive value to the status property.
the status value
this
InvalidCodeError for invalid code value
PrimitiveTypeError for invalid primitive types
CodeSystem Enumeration: FmStatusEnum
true if the status property exists and has a value; false otherwise
the kind property value as a CodeableConcept object if defined; else an empty CodeableConcept object
Assigns the provided Kind object value to the kind property.
the kind object value
this
InvalidTypeError for invalid data types
true if the kind property exists and has a value; false otherwise
the period property value as a Period object if defined; else an empty Period object
Assigns the provided Period object value to the period property.
the period object value
this
InvalidTypeError for invalid data types
true if the period property exists and has a value; false otherwise
the created property value as a DateTimeType object if defined; else an empty DateTimeType object
Assigns the provided PrimitiveType value to the created property.
the created value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the created property exists and has a value; false otherwise
the created property value as a fhirDateTime if defined; else null
Assigns the provided primitive value to the created property.
the created value
this
PrimitiveTypeError for invalid primitive types
true if the created property exists and has a value; false otherwise
the enterer property value as a Reference object; else an empty Reference object
Assigns the provided Enterer object value to the enterer property.
the enterer object value
this
@ReferenceTargets('PaymentReconciliation.enterer', ['Practitioner','PractitionerRole','Organization',])
InvalidTypeError for invalid data type or reference value
true if the enterer property exists and has a value; false otherwise
the issuerType property value as a CodeableConcept object if defined; else an empty CodeableConcept object
Assigns the provided IssuerType object value to the issuerType property.
the issuerType object value
this
InvalidTypeError for invalid data types
true if the issuerType property exists and has a value; false otherwise
the paymentIssuer property value as a Reference object; else an empty Reference object
Assigns the provided PaymentIssuer object value to the paymentIssuer property.
the paymentIssuer object value
this
@ReferenceTargets('PaymentReconciliation.paymentIssuer', ['Organization','Patient','RelatedPerson',])
InvalidTypeError for invalid data type or reference value
true if the paymentIssuer property exists and has a value; false otherwise
the request property value as a Reference object; else an empty Reference object
Assigns the provided Request object value to the request property.
the request object value
this
InvalidTypeError for invalid data type or reference value
true if the request property exists and has a value; false otherwise
the requestor property value as a Reference object; else an empty Reference object
Assigns the provided Requestor object value to the requestor property.
the requestor object value
this
@ReferenceTargets('PaymentReconciliation.requestor', ['Practitioner','PractitionerRole','Organization',])
InvalidTypeError for invalid data type or reference value
true if the requestor property exists and has a value; false otherwise
the outcome property value as a EnumCodeType if defined; else undefined
CodeSystem Enumeration: PaymentOutcomeEnum
Assigns the provided EnumCodeType value to the outcome property.
the outcome value
this
InvalidCodeError for invalid code values
InvalidTypeError for invalid data types
CodeSystem Enumeration: PaymentOutcomeEnum
true if the outcome property exists and has a value; false otherwise
the outcome property value as a CodeType if defined; else undefined
CodeSystem Enumeration: PaymentOutcomeEnum
Assigns the provided PrimitiveType value to the outcome property.
the outcome value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: PaymentOutcomeEnum
true if the outcome property exists and has a value; false otherwise
the outcome property value as a fhirCode if defined; else undefined
CodeSystem Enumeration: PaymentOutcomeEnum
Assigns the provided primitive value to the outcome property.
the outcome value
this
InvalidCodeError for invalid code value
PrimitiveTypeError for invalid primitive types
CodeSystem Enumeration: PaymentOutcomeEnum
true if the outcome property exists and has a value; false otherwise
the disposition property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the disposition property.
the disposition value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the disposition property exists and has a value; false otherwise
the disposition property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the disposition property.
the disposition value
this
PrimitiveTypeError for invalid primitive types
true if the disposition property exists and has a value; false otherwise
the date property value as a DateType object if defined; else an empty DateType object
Assigns the provided PrimitiveType value to the date property.
the date value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the date property exists and has a value; false otherwise
the date property value as a fhirDate if defined; else null
Assigns the provided primitive value to the date property.
the date value
this
PrimitiveTypeError for invalid primitive types
true if the date property exists and has a value; false otherwise
the location property value as a Reference object; else an empty Reference object
Assigns the provided Location object value to the location property.
the location object value
this
InvalidTypeError for invalid data type or reference value
true if the location property exists and has a value; false otherwise
the method property value as a CodeableConcept object if defined; else an empty CodeableConcept object
Assigns the provided Method object value to the method property.
the method object value
this
InvalidTypeError for invalid data types
true if the method property exists and has a value; false otherwise
the cardBrand property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the cardBrand property.
the cardBrand value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the cardBrand property exists and has a value; false otherwise
the cardBrand property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the cardBrand property.
the cardBrand value
this
PrimitiveTypeError for invalid primitive types
true if the cardBrand property exists and has a value; false otherwise
the accountNumber property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the accountNumber property.
the accountNumber value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the accountNumber property exists and has a value; false otherwise
the accountNumber property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the accountNumber property.
the accountNumber value
this
PrimitiveTypeError for invalid primitive types
true if the accountNumber property exists and has a value; false otherwise
the expirationDate property value as a DateType object if defined; else an empty DateType object
Assigns the provided PrimitiveType value to the expirationDate property.
the expirationDate value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the expirationDate property exists and has a value; false otherwise
the expirationDate property value as a fhirDate if defined; else undefined
Assigns the provided primitive value to the expirationDate property.
the expirationDate value
this
PrimitiveTypeError for invalid primitive types
true if the expirationDate property exists and has a value; false otherwise
the processor property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the processor property.
the processor value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the processor property exists and has a value; false otherwise
the processor property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the processor property.
the processor value
this
PrimitiveTypeError for invalid primitive types
true if the processor property exists and has a value; false otherwise
the referenceNumber property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the referenceNumber property.
the referenceNumber value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the referenceNumber property exists and has a value; false otherwise
the referenceNumber property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the referenceNumber property.
the referenceNumber value
this
PrimitiveTypeError for invalid primitive types
true if the referenceNumber property exists and has a value; false otherwise
the authorization property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the authorization property.
the authorization value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the authorization property exists and has a value; false otherwise
the authorization property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the authorization property.
the authorization value
this
PrimitiveTypeError for invalid primitive types
true if the authorization property exists and has a value; false otherwise
the tenderedAmount property value as a Money object if defined; else an empty Money object
Assigns the provided TenderedAmount object value to the tenderedAmount property.
the tenderedAmount object value
this
InvalidTypeError for invalid data types
true if the tenderedAmount property exists and has a value; false otherwise
the returnedAmount property value as a Money object if defined; else an empty Money object
Assigns the provided ReturnedAmount object value to the returnedAmount property.
the returnedAmount object value
this
InvalidTypeError for invalid data types
true if the returnedAmount property exists and has a value; false otherwise
the amount property value as a Money object if defined; else an empty Money object
Assigns the provided Money object value to the amount property.
the amount object value
this
InvalidTypeError for invalid data types
true if the amount property exists and has a value; false otherwise
the paymentIdentifier property value as a Identifier object if defined; else an empty Identifier object
Assigns the provided PaymentIdentifier object value to the paymentIdentifier property.
the paymentIdentifier object value
this
InvalidTypeError for invalid data types
true if the paymentIdentifier property exists and has a value; false otherwise
the allocation property value as a PaymentReconciliationAllocationComponent array
Assigns the provided PaymentReconciliationAllocationComponent array value to the allocation property.
the allocation array value
this
InvalidTypeError for invalid data types
Add the provided PaymentReconciliationAllocationComponent value to the allocation array property.
the allocation value
this
InvalidTypeError for invalid data types
true if the allocation property exists and has a value; false otherwise
the formCode property value as a CodeableConcept object if defined; else an empty CodeableConcept object
Assigns the provided FormCode object value to the formCode property.
the formCode object value
this
InvalidTypeError for invalid data types
true if the formCode property exists and has a value; false otherwise
the processNote property value as a PaymentReconciliationProcessNoteComponent array
Assigns the provided PaymentReconciliationProcessNoteComponent array value to the processNote property.
the processNote array value
this
InvalidTypeError for invalid data types
Add the provided PaymentReconciliationProcessNoteComponent value to the processNote array property.
the processNote value
this
InvalidTypeError for invalid data types
true if the processNote property exists and has a value; false otherwise
the FHIR type defined in the FHIR standard
true if the instance is empty; false otherwise
true if and only if the data model has required fields (min cardinality > 0)
and at least one of those required fields in the instance is empty; false otherwise
Creates a copy of the current instance.
the a new instance copied from the current instance
the JSON value or undefined if the instance is empty
the text property value as a Narrative
Assigns the provided value to the text property.
the text value
this
true if the text property exists and has a value; false otherwise
the contained property value as a Resource array
Assigns the provided Resource array value to the contained property.
the contained array value
this
Add the provided Resource value to the contained array property.
the contained value
this
true if the contained property exists and has a value; false otherwise
the array of extension values
Assigns the provided array of Extension values to the extension property.
array of Extensions
this
Determines if the extension property exists.
Optionalurl: stringthe url that identifies a specific Extension
true if an Extension has the provided url; false otherwise
If the url is provided, determines if an Extension having
the provided url exists. If the url is not provided, determines
if the extension property exists and has any values.
AssertionError for invalid url
Returns the Extension having the provided url.
the url that identifies a specific Extension
the Extension having the provided url
AssertionError for invalid url
Adds the provided Extension to the extension property array.
the Extension value to add to the extension property array
this
Removes the Extension having the provided url from the extension property array.
the url that identifies a specific Extension to remove
AssertionError for invalid url
the array of modifierExtension values
Assigns the provided array of Extension values to the modifierExtension property.
array of Extensions
this
Determines if the modifierExtension property exists.
Optionalurl: stringthe url that identifies a specific Extension
true if an Extension has the provided url
If the url is provided, determines if an Extension having
the provided url exists. If the url is not provided, determines
if the modifierExtension property exists and has any values.
AssertionError for invalid url
Returns the Extension having the provided url.
the url that identifies a specific Extension
the Extension having the provided url
AssertionError for invalid url
Adds the provided Extension to the modifierExtension property array.
the Extension value to add to the modifierExtension property array
this
Removes the Extension having the provided url from the modifierExtension property array.
the url that identifies a specific Extension to remove
AssertionError for invalid url
the FHIR resource type as defined by the FHIR specification
the id property value as a PrimitiveType
Assigns the provided PrimitiveType value to the id property.
the id value
this
true if the id property exists and has a value; false otherwise
the id property value as a primitive value
Assigns the provided primitive value to the id property.
the id value
this
PrimitiveTypeError for invalid primitive types
true if the id property exists and has a value; false otherwise
the meta property value as a Meta
Assigns the provided value to the meta property.
the meta value
this
true if the meta property exists and has a value; false otherwise
the implicitRules property value as a PrimitiveType
Assigns the provided PrimitiveType value to the implicitRules property.
the implicitRules value
this
true if the implicitRules property exists and has a value; false otherwise
the implicitRules property value as a primitive value
Assigns the provided primitive value to the implicitRules property.
the implicitRules value
this
PrimitiveTypeError for invalid primitive types
true if the system property exists and has a value; false otherwise
the language property value as a PrimitiveType
Assigns the provided PrimitiveType value to the language property.
the language value
this
true if the language property exists and has a value; false otherwise
the language property value as a primitive value
Assigns the provided primitive value to the language property.
the language value
this
PrimitiveTypeError for invalid primitive types
true if the language property exists and has a value; false otherwise
true if the instance is a FHIR resource; false otherwise
true if the instance is a FHIR complex or primitive datatype; false otherwise
true if the instance is a FHIR complex datatype; false otherwise
true if the instance is a FHIR primitive datatype; false otherwise
true if the instance is a FHIR primitive boolean datatype; false otherwise
true if the instance is a FHIR primitive string-based datatype; false otherwise
true if the instance is a FHIR primitive number-based datatype; false otherwise
true if the instance is a FHIR primitive bigint-based datatype; false otherwise
true if the instance is a FHIR primitive datetime-based datatype; false otherwise
ProtectedcopyProtectedCopies the current instance's elements into the provided object.
the copied instance
PrivateinitInitialize the identifier property
PrivateinitInitialize the allocation property
PrivateinitInitialize the processNote property
PaymentReconciliation Class
Remarks
This resource provides the details including amount of a payment and allocates the payment items being paid.
FHIR Specification
See
FHIR PaymentReconciliation