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

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: Nphies Payment Notice

Nphies Payment Notice Profile

Usage:

• Examples for this Resource Profile: PaymentNotice/99061

Formal Views of Profile Content

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

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from PaymentNotice

Name	Flags	Card.	Type	Description & Constraints
PaymentNotice		0..*	PaymentNotice	PaymentNotice request
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..*	DP_Identifier_A	Business Identifier for the payment noctice
status		1..1	code	active | cancelled | draft | entered-in-error 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		1..1	DP_Money_SAR	Monetary amount of the payment
paymentStatus		1..1	DP_CodeableConcept	Issued or cleared Status of the payment Binding: PaymentStatusCodes (required)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
PaymentNotice.paymentStatus	required	PaymentStatusCodes http://hl7.org/fhir/ValueSet/payment-status from the FHIR Standard

Name	Flags	Card.	Type	Description & Constraints
PaymentNotice		0..*	PaymentNotice	PaymentNotice request dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
id	Σ	1..1	id	Logical id of this artifact Max Length:64
meta	Σ	1..1	Meta	Metadata about the resource ele-1: All FHIR elements must have a @value or children
profile	Σ	1..*	DP_canonical(StructureDefinition)	Profiles this resource claims to conform to ele-1: All FHIR elements must have a @value or children
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
identifier		1..*	DP_Identifier_A	Business Identifier for the payment noctice ele-1: All FHIR elements must have a @value or children
status	?!Σ	1..1	code	active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. ele-1: All FHIR elements must have a @value or children Required Pattern: active
created	Σ	1..1	DP_dateTime	Creation date ele-1: All FHIR elements must have a @value or children
provider		1..1	DP_Reference_1or2a(Nphies Provider Organization)	Responsible practitioner ele-1: All FHIR elements must have a @value or children
payment	Σ	1..1	DP_Reference_1or3a(Nphies Payment Reconciliation)	Payment reference ele-1: All FHIR elements must have a @value or children
paymentDate		1..1	DP_date	Payment or clearing date ele-1: All FHIR elements must have a @value or children
payee		1..1	DP_Reference_1or2a(Nphies Provider Organization)	Party being paid ele-1: All FHIR elements must have a @value or children
recipient	Σ	1..1	DP_Reference_2a(Nphies Organization)	Party being notified ele-1: All FHIR elements must have a @value or children
amount	Σ	1..1	DP_Money_SAR	Monetary amount of the payment ele-1: All FHIR elements must have a @value or children
paymentStatus		1..1	DP_CodeableConcept	Issued or cleared Status of the payment Binding: PaymentStatusCodes (required) ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
PaymentNotice.status	required	Pattern: active http://hl7.org/fhir/ValueSet/fm-status|4.0.1 from the FHIR Standard
PaymentNotice.paymentStatus	required	PaymentStatusCodes http://hl7.org/fhir/ValueSet/payment-status from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	PaymentNotice	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	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	error	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	error	PaymentNotice	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	PaymentNotice	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
PaymentNotice		0..*	PaymentNotice	PaymentNotice request
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
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
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..*	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	Σ	1..1	DP_Money_SAR	Monetary amount of the payment
paymentStatus		1..1	DP_CodeableConcept	Issued or cleared Status of the payment Binding: PaymentStatusCodes (required)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
PaymentNotice.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
PaymentNotice.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
PaymentNotice.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
PaymentNotice.status	required	Pattern: active http://hl7.org/fhir/ValueSet/fm-status|4.0.1 from the FHIR Standard
PaymentNotice.paymentStatus	required	PaymentStatusCodes http://hl7.org/fhir/ValueSet/payment-status from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	PaymentNotice	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	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	error	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	error	PaymentNotice	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	PaymentNotice	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 PaymentNotice

Summary

Mandatory: 8 elements

Structures

This structure refers to these other structures:

• DP_canonical (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-canonical)
• DP_Identifier_A (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-Identifier-A)
• DP_dateTime (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-dateTime)
• DP_Reference_1or2a (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-Reference-1or2a)
• Nphies Provider Organization (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/provider-organization)
• DP_Reference_1or3a (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-Reference-1or3a)
• Nphies Payment Reconciliation (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/payment-reconciliation)
• DP_date (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-date)
• DP_Reference_2a (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-Reference-2a)
• Nphies Organization (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/organization)
• DP_Money_SAR (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-Money-SAR)
• DP_CodeableConcept (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-CodeableConcept)

Differential View

This structure is derived from PaymentNotice

Name	Flags	Card.	Type	Description & Constraints
PaymentNotice		0..*	PaymentNotice	PaymentNotice request
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..*	DP_Identifier_A	Business Identifier for the payment noctice
status		1..1	code	active | cancelled | draft | entered-in-error 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		1..1	DP_Money_SAR	Monetary amount of the payment
paymentStatus		1..1	DP_CodeableConcept	Issued or cleared Status of the payment Binding: PaymentStatusCodes (required)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
PaymentNotice.paymentStatus	required	PaymentStatusCodes http://hl7.org/fhir/ValueSet/payment-status from the FHIR Standard

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
PaymentNotice		0..*	PaymentNotice	PaymentNotice request dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
id	Σ	1..1	id	Logical id of this artifact Max Length:64
meta	Σ	1..1	Meta	Metadata about the resource ele-1: All FHIR elements must have a @value or children
profile	Σ	1..*	DP_canonical(StructureDefinition)	Profiles this resource claims to conform to ele-1: All FHIR elements must have a @value or children
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
identifier		1..*	DP_Identifier_A	Business Identifier for the payment noctice ele-1: All FHIR elements must have a @value or children
status	?!Σ	1..1	code	active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. ele-1: All FHIR elements must have a @value or children Required Pattern: active
created	Σ	1..1	DP_dateTime	Creation date ele-1: All FHIR elements must have a @value or children
provider		1..1	DP_Reference_1or2a(Nphies Provider Organization)	Responsible practitioner ele-1: All FHIR elements must have a @value or children
payment	Σ	1..1	DP_Reference_1or3a(Nphies Payment Reconciliation)	Payment reference ele-1: All FHIR elements must have a @value or children
paymentDate		1..1	DP_date	Payment or clearing date ele-1: All FHIR elements must have a @value or children
payee		1..1	DP_Reference_1or2a(Nphies Provider Organization)	Party being paid ele-1: All FHIR elements must have a @value or children
recipient	Σ	1..1	DP_Reference_2a(Nphies Organization)	Party being notified ele-1: All FHIR elements must have a @value or children
amount	Σ	1..1	DP_Money_SAR	Monetary amount of the payment ele-1: All FHIR elements must have a @value or children
paymentStatus		1..1	DP_CodeableConcept	Issued or cleared Status of the payment Binding: PaymentStatusCodes (required) ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
PaymentNotice.status	required	Pattern: active http://hl7.org/fhir/ValueSet/fm-status|4.0.1 from the FHIR Standard
PaymentNotice.paymentStatus	required	PaymentStatusCodes http://hl7.org/fhir/ValueSet/payment-status from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	PaymentNotice	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	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	error	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	error	PaymentNotice	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	PaymentNotice	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
PaymentNotice		0..*	PaymentNotice	PaymentNotice request
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
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
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..*	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	Σ	1..1	DP_Money_SAR	Monetary amount of the payment
paymentStatus		1..1	DP_CodeableConcept	Issued or cleared Status of the payment Binding: PaymentStatusCodes (required)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
PaymentNotice.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
PaymentNotice.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
PaymentNotice.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
PaymentNotice.status	required	Pattern: active http://hl7.org/fhir/ValueSet/fm-status|4.0.1 from the FHIR Standard
PaymentNotice.paymentStatus	required	PaymentStatusCodes http://hl7.org/fhir/ValueSet/payment-status from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	PaymentNotice	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	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	error	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	error	PaymentNotice	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	PaymentNotice	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 PaymentNotice

Summary

Mandatory: 8 elements

Structures

This structure refers to these other structures:

• DP_canonical (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-canonical)
• DP_Identifier_A (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-Identifier-A)
• DP_dateTime (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-dateTime)
• DP_Reference_1or2a (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-Reference-1or2a)
• Nphies Provider Organization (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/provider-organization)
• DP_Reference_1or3a (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-Reference-1or3a)
• Nphies Payment Reconciliation (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/payment-reconciliation)
• DP_date (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-date)
• DP_Reference_2a (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-Reference-2a)
• Nphies Organization (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/organization)
• DP_Money_SAR (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-Money-SAR)
• DP_CodeableConcept (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-CodeableConcept)

Other representations of profile: CSV, Excel, Schematron