FHIR Implementation Guide for HCX
0.0.1 - CI Build

FHIR Implementation Guide for HCX - Local Development build (v0.0.1). See the Directory of published versions

Resource Profile: HCX Payment Notice

Defining URL:http://hl7.org/fhir/StructureDefinition/HCXPaymentNotice
Version:0.0.1
Name:PaymentNotice
Status:Draft as of 2019-11-01T09:29:23+11:00 (Standards Status: Trial Use)
Definition:

This resource provides the status of the payment for goods and services rendered, and the request and response resource references.

Publisher:HL7 International - HCX
Committee:Financial Management
Maturity:2
Source Resource:XML / JSON / Turtle

The official URL for this profile is:

http://hl7.org/fhir/StructureDefinition/HCXPaymentNotice

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from PaymentNotice

Summary

Mandatory: 9 elements

Maturity: 2

This structure is derived from PaymentNotice

NameFlagsCard.TypeDescription & Constraintsdoco
.. PaymentNotice 0..*PaymentNoticePaymentNotice request
... identifier 1..1IdentifierBusiness Identifier for the payment noctice
... status ?!Σ1..1codeactive | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.

... request 1..1Reference(Resource)Request reference
... created Σ1..1dateTimeCreation date
... provider 1..1Reference(Practitioner | PractitionerRole | Organization)Responsible practitioner
... payment Σ1..1Reference(PaymentReconciliation)Payment reference
... paymentDate 0..1datePayment or clearing date
... payee 0..1Reference(Practitioner | PractitionerRole | Organization)Party being paid
... recipient Σ1..1Reference(Organization)Party being notified
... amount Σ1..1MoneyMonetary amount of the payment
... paymentStatus 0..1CodeableConceptIssued or cleared Status of the payment
Binding: PaymentStatusCodes (example): The payment conveyance status codes.


doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. PaymentNotice 0..*PaymentNoticePaymentNotice request
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 1..1IdentifierBusiness Identifier for the payment noctice
... status ?!Σ1..1codeactive | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.

... request 1..1Reference(Resource)Request reference
... response 1..1Reference(Resource)Response reference
... created Σ1..1dateTimeCreation date
... provider 1..1Reference(Practitioner | PractitionerRole | Organization)Responsible practitioner
... payment Σ1..1Reference(PaymentReconciliation)Payment reference
... paymentDate 0..1datePayment or clearing date
... payee 0..1Reference(Practitioner | PractitionerRole | Organization)Party being paid
... recipient Σ1..1Reference(Organization)Party being notified
... amount Σ1..1MoneyMonetary amount of the payment
... paymentStatus 0..1CodeableConceptIssued or cleared Status of the payment
Binding: PaymentStatusCodes (example): The payment conveyance status codes.


doco Documentation for this format

This structure is derived from PaymentNotice

Summary

Mandatory: 9 elements

Maturity: 2

Differential View

This structure is derived from PaymentNotice

NameFlagsCard.TypeDescription & Constraintsdoco
.. PaymentNotice 0..*PaymentNoticePaymentNotice request
... identifier 1..1IdentifierBusiness Identifier for the payment noctice
... status ?!Σ1..1codeactive | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.

... request 1..1Reference(Resource)Request reference
... created Σ1..1dateTimeCreation date
... provider 1..1Reference(Practitioner | PractitionerRole | Organization)Responsible practitioner
... payment Σ1..1Reference(PaymentReconciliation)Payment reference
... paymentDate 0..1datePayment or clearing date
... payee 0..1Reference(Practitioner | PractitionerRole | Organization)Party being paid
... recipient Σ1..1Reference(Organization)Party being notified
... amount Σ1..1MoneyMonetary amount of the payment
... paymentStatus 0..1CodeableConceptIssued or cleared Status of the payment
Binding: PaymentStatusCodes (example): The payment conveyance status codes.


doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PaymentNotice 0..*PaymentNoticePaymentNotice request
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 1..1IdentifierBusiness Identifier for the payment noctice
... status ?!Σ1..1codeactive | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.

... request 1..1Reference(Resource)Request reference
... response 1..1Reference(Resource)Response reference
... created Σ1..1dateTimeCreation date
... provider 1..1Reference(Practitioner | PractitionerRole | Organization)Responsible practitioner
... payment Σ1..1Reference(PaymentReconciliation)Payment reference
... paymentDate 0..1datePayment or clearing date
... payee 0..1Reference(Practitioner | PractitionerRole | Organization)Party being paid
... recipient Σ1..1Reference(Organization)Party being notified
... amount Σ1..1MoneyMonetary amount of the payment
... paymentStatus 0..1CodeableConceptIssued or cleared Status of the payment
Binding: PaymentStatusCodes (example): The payment conveyance status codes.


doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
PaymentNotice.languagepreferredCommonLanguages
Max Binding: AllLanguages
PaymentNotice.statusrequiredFinancialResourceStatusCodes
PaymentNotice.paymentStatusexamplePaymentStatusCodes

Constraints

IdPathDetailsRequirements
dom-2PaymentNoticeIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3PaymentNoticeIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4PaymentNoticeIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5PaymentNoticeIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6PaymentNoticeA resource should have narrative for robust management
: text.`div`.exists()
ele-1PaymentNotice.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PaymentNotice.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PaymentNotice.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PaymentNotice.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PaymentNotice.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1PaymentNotice.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1PaymentNotice.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1PaymentNotice.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1PaymentNotice.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PaymentNotice.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PaymentNotice.requestAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PaymentNotice.responseAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PaymentNotice.createdAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PaymentNotice.providerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PaymentNotice.paymentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PaymentNotice.paymentDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PaymentNotice.payeeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PaymentNotice.recipientAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PaymentNotice.amountAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PaymentNotice.paymentStatusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())