Healthcare Financial Services IG Edition 1
0.3.0 - STU-Ballot Saudi Arabia flag

Healthcare Financial Services IG Edition 1 - Local Development build (v0.3.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Nphies Payment Notice

Official URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/payment-notice Version: 0.3.0
Draft as of 2025-07-30 Computable Name: NphiesPaymentNotice

Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License

Nphies Payment Notice Profile

Usages:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PaymentNotice C 0..* PaymentNotice PaymentNotice request
Constraints: BV-00336, BV-00358
... id Σ 1..1 id Logical id of this artifact
Max Length:64
... meta Σ 1..1 Meta Metadata about the resource
.... profile Σ 1..* DP_canonical(StructureDefinition) Profiles this resource claims to conform to
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... identifier 1..1 DP_Identifier_A 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.
Required Pattern: active
... created Σ 1..1 DP_dateTime Creation date
... provider 1..1 DP_Reference_1or2a(Nphies Provider Organization) Responsible practitioner
... payment Σ 1..1 DP_Reference_1or3a(Nphies Payment Reconciliation) Payment reference
... paymentDate 1..1 DP_date Payment or clearing date
... payee 1..1 DP_Reference_1or2a(Nphies Provider Organization) Party being paid
... recipient Σ 1..1 DP_Reference_2a(Nphies Organization) Party being notified
... amount ΣC 1..1 DP_Money_SAR Monetary amount of the payment
Constraints: BV-00091
... paymentStatus 1..1 DP_CodeableConcept Issued or cleared Status of the payment
Binding: PaymentStatusCodes (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
PaymentNotice.statusrequiredPattern Value: active
http://hl7.org/fhir/ValueSet/fm-status|4.0.1
From the FHIR Standard
PaymentNotice.paymentStatusrequiredPaymentStatusCodes
http://hl7.org/fhir/ValueSet/payment-status
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
BV-00091errorPaymentNotice.amountPaymentNotice amount currency is not SAR.
: currency = 'SAR'
BV-00336errorPaymentNoticePaymentNotice status is not using the specified value 'active'.
: status.exists() implies status='active'
BV-00358errorPaymentNoticePaymentNotice paymentDate cannot be in the future.
: paymentDate.exists() implies paymentDate <= now()
dom-2errorPaymentNoticeIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPaymentNoticeIf 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-4errorPaymentNoticeIf 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-5errorPaymentNoticeIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePaymentNoticeA resource should have narrative for robust management
: text.`div`.exists()
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()

This structure is derived from PaymentNotice

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PaymentNotice C 0..* PaymentNotice PaymentNotice request
Constraints: BV-00336, BV-00358
... id 1..1 id Logical id of this artifact
Max Length:64
... meta 1..1 Meta Metadata about the resource
.... profile 1..* DP_canonical(StructureDefinition) Profiles this resource claims to conform to
... identifier 1..1 DP_Identifier_A Business Identifier for the payment noctice
... created 1..1 DP_dateTime Creation date
... provider 1..1 DP_Reference_1or2a(Nphies Provider Organization) Responsible practitioner
... payment 1..1 DP_Reference_1or3a(Nphies Payment Reconciliation) Payment reference
... paymentDate 1..1 DP_date Payment or clearing date
... payee 1..1 DP_Reference_1or2a(Nphies Provider Organization) Party being paid
... recipient 1..1 DP_Reference_2a(Nphies Organization) Party being notified
... amount C 1..1 DP_Money_SAR Monetary amount of the payment
Constraints: BV-00091
... paymentStatus 1..1 DP_CodeableConcept Issued or cleared Status of the payment
Binding: PaymentStatusCodes (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
PaymentNotice.paymentStatusrequiredPaymentStatusCodes
http://hl7.org/fhir/ValueSet/payment-status
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
BV-00091errorPaymentNotice.amountPaymentNotice amount currency is not SAR.
: currency = 'SAR'
BV-00336errorPaymentNoticePaymentNotice status is not using the specified value 'active'.
: status.exists() implies status='active'
BV-00358errorPaymentNoticePaymentNotice paymentDate cannot be in the future.
: paymentDate.exists() implies paymentDate <= now()
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PaymentNotice C 0..* PaymentNotice PaymentNotice request
Constraints: BV-00336, BV-00358
... id Σ 1..1 id Logical id of this artifact
Max Length:64
... meta Σ 1..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 1..* DP_canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... 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 DP_Identifier_A 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.
Required Pattern: active
... request 0..1 Reference(Resource) Request reference
... response 0..1 Reference(Resource) Response reference
... created Σ 1..1 DP_dateTime Creation date
... provider 1..1 DP_Reference_1or2a(Nphies Provider Organization) Responsible practitioner
... payment Σ 1..1 DP_Reference_1or3a(Nphies Payment Reconciliation) Payment reference
... paymentDate 1..1 DP_date Payment or clearing date
... payee 1..1 DP_Reference_1or2a(Nphies Provider Organization) Party being paid
... recipient Σ 1..1 DP_Reference_2a(Nphies Organization) Party being notified
... amount ΣC 1..1 DP_Money_SAR Monetary amount of the payment
Constraints: BV-00091
... paymentStatus 1..1 DP_CodeableConcept Issued or cleared Status of the payment
Binding: PaymentStatusCodes (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
PaymentNotice.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
From the FHIR Standard
PaymentNotice.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
From the FHIR Standard
PaymentNotice.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
PaymentNotice.statusrequiredPattern Value: active
http://hl7.org/fhir/ValueSet/fm-status|4.0.1
From the FHIR Standard
PaymentNotice.paymentStatusrequiredPaymentStatusCodes
http://hl7.org/fhir/ValueSet/payment-status
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
BV-00091errorPaymentNotice.amountPaymentNotice amount currency is not SAR.
: currency = 'SAR'
BV-00336errorPaymentNoticePaymentNotice status is not using the specified value 'active'.
: status.exists() implies status='active'
BV-00358errorPaymentNoticePaymentNotice paymentDate cannot be in the future.
: paymentDate.exists() implies paymentDate <= now()
dom-2errorPaymentNoticeIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPaymentNoticeIf 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-4errorPaymentNoticeIf 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-5errorPaymentNoticeIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePaymentNoticeA resource should have narrative for robust management
: text.`div`.exists()
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()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PaymentNotice C 0..* PaymentNotice PaymentNotice request
Constraints: BV-00336, BV-00358
... id Σ 1..1 id Logical id of this artifact
Max Length:64
... meta Σ 1..1 Meta Metadata about the resource
.... profile Σ 1..* DP_canonical(StructureDefinition) Profiles this resource claims to conform to
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... identifier 1..1 DP_Identifier_A 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.
Required Pattern: active
... created Σ 1..1 DP_dateTime Creation date
... provider 1..1 DP_Reference_1or2a(Nphies Provider Organization) Responsible practitioner
... payment Σ 1..1 DP_Reference_1or3a(Nphies Payment Reconciliation) Payment reference
... paymentDate 1..1 DP_date Payment or clearing date
... payee 1..1 DP_Reference_1or2a(Nphies Provider Organization) Party being paid
... recipient Σ 1..1 DP_Reference_2a(Nphies Organization) Party being notified
... amount ΣC 1..1 DP_Money_SAR Monetary amount of the payment
Constraints: BV-00091
... paymentStatus 1..1 DP_CodeableConcept Issued or cleared Status of the payment
Binding: PaymentStatusCodes (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
PaymentNotice.statusrequiredPattern Value: active
http://hl7.org/fhir/ValueSet/fm-status|4.0.1
From the FHIR Standard
PaymentNotice.paymentStatusrequiredPaymentStatusCodes
http://hl7.org/fhir/ValueSet/payment-status
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
BV-00091errorPaymentNotice.amountPaymentNotice amount currency is not SAR.
: currency = 'SAR'
BV-00336errorPaymentNoticePaymentNotice status is not using the specified value 'active'.
: status.exists() implies status='active'
BV-00358errorPaymentNoticePaymentNotice paymentDate cannot be in the future.
: paymentDate.exists() implies paymentDate <= now()
dom-2errorPaymentNoticeIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPaymentNoticeIf 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-4errorPaymentNoticeIf 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-5errorPaymentNoticeIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePaymentNoticeA resource should have narrative for robust management
: text.`div`.exists()
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()

Differential View

This structure is derived from PaymentNotice

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PaymentNotice C 0..* PaymentNotice PaymentNotice request
Constraints: BV-00336, BV-00358
... id 1..1 id Logical id of this artifact
Max Length:64
... meta 1..1 Meta Metadata about the resource
.... profile 1..* DP_canonical(StructureDefinition) Profiles this resource claims to conform to
... identifier 1..1 DP_Identifier_A Business Identifier for the payment noctice
... created 1..1 DP_dateTime Creation date
... provider 1..1 DP_Reference_1or2a(Nphies Provider Organization) Responsible practitioner
... payment 1..1 DP_Reference_1or3a(Nphies Payment Reconciliation) Payment reference
... paymentDate 1..1 DP_date Payment or clearing date
... payee 1..1 DP_Reference_1or2a(Nphies Provider Organization) Party being paid
... recipient 1..1 DP_Reference_2a(Nphies Organization) Party being notified
... amount C 1..1 DP_Money_SAR Monetary amount of the payment
Constraints: BV-00091
... paymentStatus 1..1 DP_CodeableConcept Issued or cleared Status of the payment
Binding: PaymentStatusCodes (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
PaymentNotice.paymentStatusrequiredPaymentStatusCodes
http://hl7.org/fhir/ValueSet/payment-status
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
BV-00091errorPaymentNotice.amountPaymentNotice amount currency is not SAR.
: currency = 'SAR'
BV-00336errorPaymentNoticePaymentNotice status is not using the specified value 'active'.
: status.exists() implies status='active'
BV-00358errorPaymentNoticePaymentNotice paymentDate cannot be in the future.
: paymentDate.exists() implies paymentDate <= now()

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PaymentNotice C 0..* PaymentNotice PaymentNotice request
Constraints: BV-00336, BV-00358
... id Σ 1..1 id Logical id of this artifact
Max Length:64
... meta Σ 1..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 1..* DP_canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... 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 DP_Identifier_A 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.
Required Pattern: active
... request 0..1 Reference(Resource) Request reference
... response 0..1 Reference(Resource) Response reference
... created Σ 1..1 DP_dateTime Creation date
... provider 1..1 DP_Reference_1or2a(Nphies Provider Organization) Responsible practitioner
... payment Σ 1..1 DP_Reference_1or3a(Nphies Payment Reconciliation) Payment reference
... paymentDate 1..1 DP_date Payment or clearing date
... payee 1..1 DP_Reference_1or2a(Nphies Provider Organization) Party being paid
... recipient Σ 1..1 DP_Reference_2a(Nphies Organization) Party being notified
... amount ΣC 1..1 DP_Money_SAR Monetary amount of the payment
Constraints: BV-00091
... paymentStatus 1..1 DP_CodeableConcept Issued or cleared Status of the payment
Binding: PaymentStatusCodes (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
PaymentNotice.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
From the FHIR Standard
PaymentNotice.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
From the FHIR Standard
PaymentNotice.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
PaymentNotice.statusrequiredPattern Value: active
http://hl7.org/fhir/ValueSet/fm-status|4.0.1
From the FHIR Standard
PaymentNotice.paymentStatusrequiredPaymentStatusCodes
http://hl7.org/fhir/ValueSet/payment-status
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
BV-00091errorPaymentNotice.amountPaymentNotice amount currency is not SAR.
: currency = 'SAR'
BV-00336errorPaymentNoticePaymentNotice status is not using the specified value 'active'.
: status.exists() implies status='active'
BV-00358errorPaymentNoticePaymentNotice paymentDate cannot be in the future.
: paymentDate.exists() implies paymentDate <= now()
dom-2errorPaymentNoticeIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPaymentNoticeIf 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-4errorPaymentNoticeIf 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-5errorPaymentNoticeIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePaymentNoticeA resource should have narrative for robust management
: text.`div`.exists()
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()

 

Other representations of profile: CSV, Excel, Schematron