EHI Export Implementation Guide
0.1.0 - ci-build
EHI Export Implementation Guide
0.1.0 - ci-build
EHI Export Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions
| Official URL: https://ehi-export.pointclickcare.com//StructureDefinition/Payment | Version: 0.1.0 | |||
| Draft as of 2024-02-05 | Computable Name: EHIPayment | |||
This resource provides the status of the payment for goods and services rendered, and the request and response resource references.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from DomainResource
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Payment | 0..* | DomainResource | Payment | |
  arAmount | Σ | 0..1 | Money | AR amount for the payment |
 cashReceiptType | Σ | 0..1 | string | Cash receipt type |
| createdDate | Σ | 0..1 | dateTime | Timestamp when the payment was created |
| effectiveDateTime | Σ | 0..1 | dateTime | Timestamp when the payment was effective |
| identifier | Σ | 1..1 | Identifier | Identification key |
| payerDescription | Σ | 0..1 | string | Payer description |
| payerType | Σ | 0..1 | string | Payer type |
| receiptAmount | Σ | 0..1 | Money | Receipt amount for the payment |
| revisionDate | Σ | 0..1 | dateTime | Timestamp when the payment was revised |
 subject | Σ | 1..1 | Reference(Patient) | Patient subject reference |
 trustAmount | Σ | 0..1 | Money | Trust amount for the payment |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Payment | 0..* | DomainResource | Payment | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
| arAmount | Σ | 0..1 | Money | AR amount for the payment |
| cashReceiptType | Σ | 0..1 | string | Cash receipt type |
| createdDate | Σ | 0..1 | dateTime | Timestamp when the payment was created |
| effectiveDateTime | Σ | 0..1 | dateTime | Timestamp when the payment was effective |
| identifier | Σ | 1..1 | Identifier | Identification key |
| payerDescription | Σ | 0..1 | string | Payer description |
| payerType | Σ | 0..1 | string | Payer type |
| receiptAmount | Σ | 0..1 | Money | Receipt amount for the payment |
| revisionDate | Σ | 0..1 | dateTime | Timestamp when the payment was revised |
| subject | Σ | 1..1 | Reference(Patient) | Patient subject reference |
| trustAmount | Σ | 0..1 | Money | Trust amount for the payment |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Payment | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Payment | 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 | error | Payment | 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 | error | Payment | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Payment | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Payment | 0..* | DomainResource | Payment | |||||
| 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): 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 Slice: Unordered, Open by value:url | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
| arAmount | Σ | 0..1 | Money | AR amount for the payment | ||||
| cashReceiptType | Σ | 0..1 | string | Cash receipt type | ||||
| createdDate | Σ | 0..1 | dateTime | Timestamp when the payment was created | ||||
| effectiveDateTime | Σ | 0..1 | dateTime | Timestamp when the payment was effective | ||||
| identifier | Σ | 1..1 | Identifier | Identification key | ||||
| payerDescription | Σ | 0..1 | string | Payer description | ||||
| payerType | Σ | 0..1 | string | Payer type | ||||
| receiptAmount | Σ | 0..1 | Money | Receipt amount for the payment | ||||
| revisionDate | Σ | 0..1 | dateTime | Timestamp when the payment was revised | ||||
| subject | Σ | 1..1 | Reference(Patient) | Patient subject reference | ||||
| trustAmount | Σ | 0..1 | Money | Trust amount for the payment | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Payment.language | preferred | CommonLanguages
|
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Payment | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Payment | 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 | error | Payment | 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 | error | Payment | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Payment | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from DomainResource
Differential View
This structure is derived from DomainResource
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Payment | 0..* | DomainResource | Payment | |
| arAmount | Σ | 0..1 | Money | AR amount for the payment |
| cashReceiptType | Σ | 0..1 | string | Cash receipt type |
| createdDate | Σ | 0..1 | dateTime | Timestamp when the payment was created |
| effectiveDateTime | Σ | 0..1 | dateTime | Timestamp when the payment was effective |
| identifier | Σ | 1..1 | Identifier | Identification key |
| payerDescription | Σ | 0..1 | string | Payer description |
| payerType | Σ | 0..1 | string | Payer type |
| receiptAmount | Σ | 0..1 | Money | Receipt amount for the payment |
| revisionDate | Σ | 0..1 | dateTime | Timestamp when the payment was revised |
| subject | Σ | 1..1 | Reference(Patient) | Patient subject reference |
| trustAmount | Σ | 0..1 | Money | Trust amount for the payment |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Payment | 0..* | DomainResource | Payment | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
| arAmount | Σ | 0..1 | Money | AR amount for the payment |
| cashReceiptType | Σ | 0..1 | string | Cash receipt type |
| createdDate | Σ | 0..1 | dateTime | Timestamp when the payment was created |
| effectiveDateTime | Σ | 0..1 | dateTime | Timestamp when the payment was effective |
| identifier | Σ | 1..1 | Identifier | Identification key |
| payerDescription | Σ | 0..1 | string | Payer description |
| payerType | Σ | 0..1 | string | Payer type |
| receiptAmount | Σ | 0..1 | Money | Receipt amount for the payment |
| revisionDate | Σ | 0..1 | dateTime | Timestamp when the payment was revised |
| subject | Σ | 1..1 | Reference(Patient) | Patient subject reference |
| trustAmount | Σ | 0..1 | Money | Trust amount for the payment |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Payment | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Payment | 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 | error | Payment | 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 | error | Payment | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Payment | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Payment | 0..* | DomainResource | Payment | |||||
| 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): 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 Slice: Unordered, Open by value:url | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
| arAmount | Σ | 0..1 | Money | AR amount for the payment | ||||
| cashReceiptType | Σ | 0..1 | string | Cash receipt type | ||||
| createdDate | Σ | 0..1 | dateTime | Timestamp when the payment was created | ||||
| effectiveDateTime | Σ | 0..1 | dateTime | Timestamp when the payment was effective | ||||
| identifier | Σ | 1..1 | Identifier | Identification key | ||||
| payerDescription | Σ | 0..1 | string | Payer description | ||||
| payerType | Σ | 0..1 | string | Payer type | ||||
| receiptAmount | Σ | 0..1 | Money | Receipt amount for the payment | ||||
| revisionDate | Σ | 0..1 | dateTime | Timestamp when the payment was revised | ||||
| subject | Σ | 1..1 | Reference(Patient) | Patient subject reference | ||||
| trustAmount | Σ | 0..1 | Money | Trust amount for the payment | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Payment.language | preferred | CommonLanguages
|
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Payment | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Payment | 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 | error | Payment | 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 | error | Payment | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Payment | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from DomainResource
Other representations of profile: CSV, Excel, Schematron