FHIR Implementation Guide for HCX
0.8.0 - CI Build

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

Resource Profile: HCX Payment Notice

Defining URL:https://ig.hcxprotocol.io/v0.8/StructureDefinition-PaymentNotice.html
Version:0.8.0
Name:PaymentNotice
Status:Draft as of 2019-11-01 09:29:23+1100 (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:HCX Open Community
Maturity:0
Source Resource:XML / JSON / Turtle

The official URL for this profile is:

https://ig.hcxprotocol.io/v0.8/StructureDefinition-PaymentNotice.html

Formal Views of Profile Content

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

This structure is derived from PaymentNotice

NameFlagsCard.TypeDescription & Constraintsdoco
.. PaymentNotice 0..*PaymentNoticePaymentNotice request
... identifier 1..1IdentifierBusiness Identifier for the payment noctice
... request 1..1Reference(Resource)Request reference
... response 1..1Reference(Resource)Response reference
... payment Σ1..1Reference(PaymentReconciliation)Payment reference
... payee 0..1Reference(Practitioner | PractitionerRole | Organization)Party being paid
... recipient Σ1..1Reference(Organization)Party being notified

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. PaymentNotice 0..*PaymentNoticePaymentNotice request
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... 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

Differential View

This structure is derived from PaymentNotice

NameFlagsCard.TypeDescription & Constraintsdoco
.. PaymentNotice 0..*PaymentNoticePaymentNotice request
... identifier 1..1IdentifierBusiness Identifier for the payment noctice
... request 1..1Reference(Resource)Request reference
... response 1..1Reference(Resource)Response reference
... payment Σ1..1Reference(PaymentReconciliation)Payment reference
... payee 0..1Reference(Practitioner | PractitionerRole | Organization)Party being paid
... recipient Σ1..1Reference(Organization)Party being notified

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PaymentNotice 0..*PaymentNoticePaymentNotice request
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... 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
Additional Bindings Purpose
AllLanguages Max Binding
PaymentNotice.statusrequiredFinancialResourceStatusCodes
PaymentNotice.paymentStatusexamplePaymentStatusCodes

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()