FHIR Implementation Guide for HCX
0.0.1 - CI Build
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
| 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
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from PaymentNotice
This structure is derived from PaymentNotice
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  PaymentNotice | 0..* | PaymentNotice | PaymentNotice request | |
  identifier | 1..1 | Identifier | Business Identifier for the payment noctice | |
 status | ?!Σ | 1..1 | code | active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. |
 request | 1..1 | Reference(Resource) | Request reference | |
| response | 1..1 | Reference(Resource) | Response reference | |
| created | Σ | 1..1 | dateTime | Creation date |
| provider | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Responsible practitioner | |
| payment | Σ | 1..1 | Reference(PaymentReconciliation) | Payment reference |
| paymentDate | 0..1 | date | Payment or clearing date | |
| payee | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Party being paid | |
| recipient | Σ | 1..1 | Reference(Organization) | Party being notified |
| amount | Σ | 1..1 | Money | Monetary amount of the payment |
 paymentStatus | 0..1 | CodeableConcept | Issued or cleared Status of the payment Binding: PaymentStatusCodes (example): The payment conveyance status codes. | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| PaymentNotice | 0..* | PaymentNotice | PaymentNotice request | |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | 0..* | Extension | Additional content defined by implementations | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | 1..1 | Identifier | Business Identifier for the payment noctice | |
| status | ?!Σ | 1..1 | code | active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. |
| request | 1..1 | Reference(Resource) | Request reference | |
| response | 1..1 | Reference(Resource) | Response reference | |
| created | Σ | 1..1 | dateTime | Creation date |
| provider | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Responsible practitioner | |
| payment | Σ | 1..1 | Reference(PaymentReconciliation) | Payment reference |
| paymentDate | 0..1 | date | Payment or clearing date | |
| payee | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Party being paid | |
| recipient | Σ | 1..1 | Reference(Organization) | Party being notified |
| amount | Σ | 1..1 | Money | Monetary amount of the payment |
| paymentStatus | 0..1 | CodeableConcept | Issued or cleared Status of the payment Binding: PaymentStatusCodes (example): The payment conveyance status codes. | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| PaymentNotice | 0..* | PaymentNotice | PaymentNotice request | |
| Documentation for this format | ||||
This structure is derived from PaymentNotice
Differential View
This structure is derived from PaymentNotice
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| PaymentNotice | 0..* | PaymentNotice | PaymentNotice request | |
| identifier | 1..1 | Identifier | Business Identifier for the payment noctice | |
| status | ?!Σ | 1..1 | code | active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. |
| request | 1..1 | Reference(Resource) | Request reference | |
| response | 1..1 | Reference(Resource) | Response reference | |
| created | Σ | 1..1 | dateTime | Creation date |
| provider | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Responsible practitioner | |
| payment | Σ | 1..1 | Reference(PaymentReconciliation) | Payment reference |
| paymentDate | 0..1 | date | Payment or clearing date | |
| payee | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Party being paid | |
| recipient | Σ | 1..1 | Reference(Organization) | Party being notified |
| amount | Σ | 1..1 | Money | Monetary amount of the payment |
| paymentStatus | 0..1 | CodeableConcept | Issued or cleared Status of the payment Binding: PaymentStatusCodes (example): The payment conveyance status codes. | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| PaymentNotice | 0..* | PaymentNotice | PaymentNotice request | |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | 1..1 | Identifier | Business Identifier for the payment noctice | |
| status | ?!Σ | 1..1 | code | active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. |
| request | 1..1 | Reference(Resource) | Request reference | |
| response | 1..1 | Reference(Resource) | Response reference | |
| created | Σ | 1..1 | dateTime | Creation date |
| provider | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Responsible practitioner | |
| payment | Σ | 1..1 | Reference(PaymentReconciliation) | Payment reference |
| paymentDate | 0..1 | date | Payment or clearing date | |
| payee | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Party being paid | |
| recipient | Σ | 1..1 | Reference(Organization) | Party being notified |
| amount | Σ | 1..1 | Money | Monetary amount of the payment |
| paymentStatus | 0..1 | CodeableConcept | Issued or cleared Status of the payment Binding: PaymentStatusCodes (example): The payment conveyance status codes. | |
| Documentation for this format | ||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet |
| PaymentNotice.language | preferred | CommonLanguages Max Binding: AllLanguages |
| PaymentNotice.status | required | FinancialResourceStatusCodes |
| PaymentNotice.paymentStatus | example | PaymentStatusCodes |
| Id | Path | Details | Requirements |
| dom-2 | PaymentNotice | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | PaymentNotice | If 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-4 | PaymentNotice | If 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-5 | PaymentNotice | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | PaymentNotice | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | PaymentNotice.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PaymentNotice.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PaymentNotice.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PaymentNotice.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PaymentNotice.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | PaymentNotice.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | PaymentNotice.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | PaymentNotice.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | PaymentNotice.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PaymentNotice.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PaymentNotice.request | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PaymentNotice.response | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PaymentNotice.created | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PaymentNotice.provider | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PaymentNotice.payment | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PaymentNotice.paymentDate | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PaymentNotice.payee | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PaymentNotice.recipient | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PaymentNotice.amount | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PaymentNotice.paymentStatus | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |