kenyaClaimsIG - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

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

Resource Profile: PaymentNoticeProfile

A PaymentNotice resource

Usage:

• This Resource Profile is not used by any profiles in this Implementation Guide

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	A unique identifier genreated by the source system to identify the organization resource. This ID must be unique within the bundle, and will be used to reference the organization resource when it is needed within other resources.
meta		1..1	Meta	Metadata about a resource
profile		1..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
identifier		1..1	Identifier	A unique identifier assigned to this payment notice.
status		1..1	code	The status of the resource instance. Required Pattern: active
created		1..1	dateTime	The date when this resource was created.
provider		1..1	Reference(SHAOrganization)	The practitioner who is responsible for the services rendered to the patient. Usually the same party as the .payee.
payment		1..1	Reference(PaymentReconciliation)	A reference to the payment which is the subject of this notice.
paymentDate		1..1	date	The date when the above payment action occurred.
payee		1..1	Reference(SHAOrganization)	The party who will receive or has received payment that is the subject of this notification.
recipient		1..1	Reference(Organization)	The party who is notified of the payment status.
amount		1..1	Money	The amount sent to the payee.
paymentStatus		1..1	CodeableConcept	A code indicating whether payment has been sent or cleared.
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
PaymentNotice		0..*	PaymentNotice	PaymentNotice request
id	Σ	1..1	id	A unique identifier genreated by the source system to identify the organization resource. This ID must be unique within the bundle, and will be used to reference the organization resource when it is needed within other resources.
meta	Σ	1..1	Meta	Metadata about a resource
profile	Σ	1..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier		1..1	Identifier	A unique identifier assigned to this payment notice.
status	?!Σ	1..1	code	The status of the resource instance. Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. Required Pattern: active
created	Σ	1..1	dateTime	The date when this resource was created.
provider		1..1	Reference(SHAOrganization)	The practitioner who is responsible for the services rendered to the patient. Usually the same party as the .payee.
payment	Σ	1..1	Reference(PaymentReconciliation)	A reference to the payment which is the subject of this notice.
paymentDate		1..1	date	The date when the above payment action occurred.
payee		1..1	Reference(SHAOrganization)	The party who will receive or has received payment that is the subject of this notification.
recipient	Σ	1..1	Reference(Organization)	The party who is notified of the payment status.
amount	Σ	1..1	Money	The amount sent to the payee.
paymentStatus		1..1	CodeableConcept	A code indicating whether payment has been sent or cleared. Binding: PaymentStatusCodes (example): The payment conveyance status codes.
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	example	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	A unique identifier genreated by the source system to identify the organization resource. This ID must be unique within the bundle, and will be used to reference the organization resource when it is needed within other resources.
meta	Σ	1..1	Meta	Metadata about a 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..*	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..1	Identifier	A unique identifier assigned to this payment notice.
status	?!Σ	1..1	code	The status of the resource instance. 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	dateTime	The date when this resource was created.
provider		1..1	Reference(SHAOrganization)	The practitioner who is responsible for the services rendered to the patient. Usually the same party as the .payee.
payment	Σ	1..1	Reference(PaymentReconciliation)	A reference to the payment which is the subject of this notice.
paymentDate		1..1	date	The date when the above payment action occurred.
payee		1..1	Reference(SHAOrganization)	The party who will receive or has received payment that is the subject of this notification.
recipient	Σ	1..1	Reference(Organization)	The party who is notified of the payment status.
amount	Σ	1..1	Money	The amount sent to the payee.
paymentStatus		1..1	CodeableConcept	A code indicating whether payment has been sent or cleared. Binding: PaymentStatusCodes (example): The payment conveyance status codes.
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 Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
PaymentNotice.status	required	Pattern: active http://hl7.org/fhir/ValueSet/fm-status|4.0.1 from the FHIR Standard
PaymentNotice.paymentStatus	example	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:

• SHAOrganization (https://shr.tiberbuapps.com/fhir/StructureDefinition/SHAOrganization)

Differential View

This structure is derived from PaymentNotice

Name	Flags	Card.	Type	Description & Constraints
PaymentNotice		0..*	PaymentNotice	PaymentNotice request
id		1..1	id	A unique identifier genreated by the source system to identify the organization resource. This ID must be unique within the bundle, and will be used to reference the organization resource when it is needed within other resources.
meta		1..1	Meta	Metadata about a resource
profile		1..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
identifier		1..1	Identifier	A unique identifier assigned to this payment notice.
status		1..1	code	The status of the resource instance. Required Pattern: active
created		1..1	dateTime	The date when this resource was created.
provider		1..1	Reference(SHAOrganization)	The practitioner who is responsible for the services rendered to the patient. Usually the same party as the .payee.
payment		1..1	Reference(PaymentReconciliation)	A reference to the payment which is the subject of this notice.
paymentDate		1..1	date	The date when the above payment action occurred.
payee		1..1	Reference(SHAOrganization)	The party who will receive or has received payment that is the subject of this notification.
recipient		1..1	Reference(Organization)	The party who is notified of the payment status.
amount		1..1	Money	The amount sent to the payee.
paymentStatus		1..1	CodeableConcept	A code indicating whether payment has been sent or cleared.
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
PaymentNotice		0..*	PaymentNotice	PaymentNotice request
id	Σ	1..1	id	A unique identifier genreated by the source system to identify the organization resource. This ID must be unique within the bundle, and will be used to reference the organization resource when it is needed within other resources.
meta	Σ	1..1	Meta	Metadata about a resource
profile	Σ	1..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier		1..1	Identifier	A unique identifier assigned to this payment notice.
status	?!Σ	1..1	code	The status of the resource instance. Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. Required Pattern: active
created	Σ	1..1	dateTime	The date when this resource was created.
provider		1..1	Reference(SHAOrganization)	The practitioner who is responsible for the services rendered to the patient. Usually the same party as the .payee.
payment	Σ	1..1	Reference(PaymentReconciliation)	A reference to the payment which is the subject of this notice.
paymentDate		1..1	date	The date when the above payment action occurred.
payee		1..1	Reference(SHAOrganization)	The party who will receive or has received payment that is the subject of this notification.
recipient	Σ	1..1	Reference(Organization)	The party who is notified of the payment status.
amount	Σ	1..1	Money	The amount sent to the payee.
paymentStatus		1..1	CodeableConcept	A code indicating whether payment has been sent or cleared. Binding: PaymentStatusCodes (example): The payment conveyance status codes.
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	example	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	A unique identifier genreated by the source system to identify the organization resource. This ID must be unique within the bundle, and will be used to reference the organization resource when it is needed within other resources.
meta	Σ	1..1	Meta	Metadata about a 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..*	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..1	Identifier	A unique identifier assigned to this payment notice.
status	?!Σ	1..1	code	The status of the resource instance. 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	dateTime	The date when this resource was created.
provider		1..1	Reference(SHAOrganization)	The practitioner who is responsible for the services rendered to the patient. Usually the same party as the .payee.
payment	Σ	1..1	Reference(PaymentReconciliation)	A reference to the payment which is the subject of this notice.
paymentDate		1..1	date	The date when the above payment action occurred.
payee		1..1	Reference(SHAOrganization)	The party who will receive or has received payment that is the subject of this notification.
recipient	Σ	1..1	Reference(Organization)	The party who is notified of the payment status.
amount	Σ	1..1	Money	The amount sent to the payee.
paymentStatus		1..1	CodeableConcept	A code indicating whether payment has been sent or cleared. Binding: PaymentStatusCodes (example): The payment conveyance status codes.
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 Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
PaymentNotice.status	required	Pattern: active http://hl7.org/fhir/ValueSet/fm-status|4.0.1 from the FHIR Standard
PaymentNotice.paymentStatus	example	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:

• SHAOrganization (https://shr.tiberbuapps.com/fhir/StructureDefinition/SHAOrganization)

Other representations of profile: CSV, Excel, Schematron