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 Advanced Authorization

Official URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/advanced-authorization Version: 0.3.0
Draft as of 2025-07-30 Computable Name: NphiesAdvancedAuthorization

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

Nphies Advanced Authorization Profile

Usages:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ClaimResponse C 0..* ClaimResponse Response to a claim predetermination or preauthorization
Constraints: BV-00569, BV-00570, BV-00607, BV-00609, BV-00610, BV-00611
... 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
.... extension:reissue-reason S 0..1 CodeableConcept Adjudication Reissue Reason
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-adjudication-reissue
Binding: Reissue Reason (required)
.... extension:adjudication-outcome S 0..1 CodeableConcept Adjudication Outcome
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-adjudication-outcome
Binding: Adjudication Outcome (required)
.... extension:advancedAuth-reason 1..1 DP_CodeableConcept Advanced Auth Reason
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-advancedAuth-reason
Binding: Advanced Auth Reason (required)
.... extension:newborn S 0..1 boolean Newborn
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-newborn
.... extension:prescription S 0..1 DP_Reference_3aor4() Prescription Extension
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-prescription
.... extension:serviceProvider 1..1 DP_Reference_1or2a(Nphies Provider Organization) Service Provider Extension
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-serviceProvider
.... extension:referringProvider S 0..1 DP_Reference_1or2aor4(Nphies Provider Organization) Referring Provider Extension
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-referringProvider
.... extension:supportingInfo S 0..* (Complex) Supporting Info Extension
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-supportingInfo
.... extension:diagnosis 1..* (Complex) Diagnosis Extension
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-diagnosis
.... extension:transferAuthorizationNumber S 0..1 DP_string Transfer Authorization Number
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-transferAuthorizationNumber
.... extension:transferAuthorizationPeriod S 0..1 DP_Period_2 Transfer Authorization Period
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-transferAuthorizationPeriod
.... extension:transferAuthorizationProvider S 0..1 DP_Reference_1or4(Nphies Provider Organization | Nphies Practitioner) Transfer Authorization Provider
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-transferAuthorizationProvider
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 1..1 DP_Identifier_A Business Identifier for a claim response
... status ?!Σ 1..1 DP_code active | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required)
Required Pattern: active
... type Σ 1..1 DP_CodeableConcept More granular claim type
Binding: Claim Type Codes (required)
... subType 1..1 DP_CodeableConcept More granular claim type
Binding: Claim SubType (required)
... use Σ 1..1 DP_code claim | preauthorization | predetermination
Binding: Use (required): Claim, preauthorization, predetermination.
... patient Σ 1..1 DP_Reference_1or2a(Nphies Patient) The recipient of the products and services
.... reference SΣC 0..1 string Literal reference, Relative, internal or absolute URL
Max Length:250
.... identifier SΣ 0..1 Identifier Logical reference, when literal reference is not known
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 1..1 DP_CodeableConcept Description of identifier
Binding: Patient Identifier Type (required)
..... system Σ 1..1 DP_uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
Max Length:50
.... display Σ 0..1 string Text alternative for the resource
Max Length:200
... created Σ 1..1 DP_dateTime Response creation date
... insurer Σ 1..1 DP_Reference_1or2a(Nphies Insurer Organization) Party responsible for reimbursement
... outcome Σ 1..1 DP_code queued | complete | error | partial
Binding: ClaimProcessingCodes (required): The result of the claim processing.
... disposition S 0..1 DP_string Disposition Message
... preAuthRef S 0..1 DP_string Preauthorization reference
... preAuthPeriod S 0..1 DP_Period_2 Preauthorization reference effective period
... payeeType S 0..1 DP_CodeableConcept Party to be paid any benefits payable
Binding: Claim Payee Type Codes (required)
... addItem SC 0..* BackboneElement Insurer added line items
Constraints: BV-00614
.... Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:adjudication-outcome 1..1 CodeableConcept Adjudication Outcome
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-adjudication-outcome
Binding: Adjudication Outcome (required)
..... extension:sequence 1..1 DP_positiveInt Sequence Extension
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-sequence
..... extension:diagnosesSequence S 0..* DP_positiveInt Diagnosis Sequence Extension
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-diagnosis-sequence
..... extension:informationSequence S 0..* DP_positiveInt Information Sequence Extension
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-informationSequence
..... extension:package S 0..1 boolean Package Code
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-package
..... extension:maternity 1..1 boolean Maternity
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-maternity
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... provider 0..1 DP_Reference_1or2aor4(Nphies Practitioner) Authorized providers
.... productOrService 1..1 DP_CodeableConcept_2 Billing, service, product, or drug code
Binding: USCLSCodes (example): Allowable service and product codes.
.... quantity S 0..1 DP_SimpleQuantity_1 Count of products or services
.... bodySite S 0..1 DP_CodeableConcept Anatomical location
Binding: OralSiteCodes (example): The code for the teeth, quadrant, sextant and arch.
.... subSite S 0..1 DP_CodeableConcept Anatomical sub-location
Binding: SurfaceCodes (example): The code for the tooth surface and surface combinations.
.... noteNumber S 0..* DP_positiveInt Applicable note numbers
.... adjudication 1..* BackboneElement Added items adjudication
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... category 1..1 DP_CodeableConcept Type of adjudication information
Binding: Adjudication (required)
..... reason S 0..1 DP_CodeableConcept Explanation of adjudication outcome
Binding: Adjudication Reason (required)
..... amount S 0..1 DP_Money_SAR Monetary amount
..... value S 0..1 DP_decimal Non-monetary value
.... detail S 0..* BackboneElement Insurer added line details
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:sequence 1..1 DP_positiveInt Sequence Extension
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-sequence
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... productOrService 1..1 DP_CodeableConcept_2 Billing, service, product, or drug code
Binding: USCLSCodes (example): Allowable service and product codes.
..... quantity S 0..1 DP_SimpleQuantity_1 Count of products or services
..... noteNumber S 0..* DP_positiveInt Applicable note numbers
..... adjudication 1..* BackboneElement Added items detail adjudication
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... category 1..1 DP_CodeableConcept Type of adjudication information
Binding: Adjudication (required)
...... reason S 0..1 DP_CodeableConcept Explanation of adjudication outcome
Binding: Adjudication Reason (required)
...... amount S 0..1 DP_Money_SAR Monetary amount
...... value S 0..1 DP_decimal Non-monetary value
..... subDetail S 0..* BackboneElement Insurer added line items
...... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:sequence 1..1 DP_positiveInt Sequence Extension
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-sequence
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... productOrService 1..1 DP_CodeableConcept_2 Billing, service, product, or drug code
Binding: USCLSCodes (example): Allowable service and product codes.
...... quantity S 0..1 DP_SimpleQuantity_1 Count of products or services
...... noteNumber S 0..* DP_positiveInt Applicable note numbers
...... adjudication 1..* BackboneElement Added items detail adjudication
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... category 1..1 DP_CodeableConcept Type of adjudication information
Binding: Adjudication (required)
....... reason S 0..1 DP_CodeableConcept Explanation of adjudication outcome
Binding: Adjudication Reason (required)
....... amount S 0..1 DP_Money_SAR Monetary amount
....... value S 0..1 DP_decimal Non-monetary value
... total SΣ 0..* BackboneElement Adjudication totals
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... category Σ 1..1 DP_CodeableConcept Type of adjudication information
Binding: Adjudication (required)
.... amount Σ 1..1 DP_Money_SAR Financial total for the category
... fundsReserve S 0..1 CodeableConcept Funds reserved status
Binding: Funds Reservation Codes (required)
... processNote S 0..* BackboneElement Note concerning adjudication
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... number 1..1 DP_positiveInt Note instance identifier
.... type 1..1 DP_code display | print | printoper
Binding: NoteType (required): The presentation types of notes.
.... text 1..1 DP_string Note explanatory text
.... language S 0..1 DP_CodeableConcept Language of the text
Binding: KSA Languages (required)
... insurance 1..* BackboneElement Patient insurance information
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... sequence 1..1 DP_positiveInt Insurance instance identifier
.... focal 1..1 boolean Coverage to be used for adjudication
.... coverage 1..1 DP_Reference_1(Coverage) Insurance information

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ClaimResponse.statusrequiredPattern Value: active
http://hl7.org/fhir/ValueSet/fm-status
From the FHIR Standard
ClaimResponse.typerequiredClaimTypeCodes
http://nphies.sa/terminology/ValueSet/claim-type
From this IG
ClaimResponse.subTyperequiredClaimSubType(a valid code from Claim SubType)
http://nphies.sa/terminology/ValueSet/claim-subtype
From this IG
ClaimResponse.userequiredUse
http://hl7.org/fhir/ValueSet/claim-use|4.0.1
From the FHIR Standard
ClaimResponse.patient.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
ClaimResponse.patient.identifier.typerequiredPatientIdentifierType
http://nphies.sa/terminology/ValueSet/patient-identifier-type
From this IG
ClaimResponse.outcomerequiredClaimProcessingCodes
http://hl7.org/fhir/ValueSet/remittance-outcome|4.0.1
From the FHIR Standard
ClaimResponse.payeeTyperequiredClaim Payee Type Codes
http://hl7.org/fhir/ValueSet/payeetype
From the FHIR Standard
ClaimResponse.addItem.productOrServiceexampleUSCLSCodes
http://hl7.org/fhir/ValueSet/service-uscls
From the FHIR Standard
ClaimResponse.addItem.bodySiteexampleOralSiteCodes
http://hl7.org/fhir/ValueSet/tooth
From the FHIR Standard
ClaimResponse.addItem.subSiteexampleSurfaceCodes
http://hl7.org/fhir/ValueSet/surface
From the FHIR Standard
ClaimResponse.addItem.adjudication.categoryrequiredAdjudication
http://nphies.sa/terminology/ValueSet/adjudication
From this IG
ClaimResponse.addItem.adjudication.reasonrequiredAdjudicationReason(a valid code from Adjudication Reason)
http://nphies.sa/terminology/ValueSet/adjudication-reason
From this IG
ClaimResponse.addItem.detail.productOrServiceexampleUSCLSCodes
http://hl7.org/fhir/ValueSet/service-uscls
From the FHIR Standard
ClaimResponse.addItem.detail.adjudication.categoryrequiredAdjudication
http://nphies.sa/terminology/ValueSet/adjudication
From this IG
ClaimResponse.addItem.detail.adjudication.reasonrequiredAdjudicationReason(a valid code from Adjudication Reason)
http://nphies.sa/terminology/ValueSet/adjudication-reason
From this IG
ClaimResponse.addItem.detail.subDetail.productOrServiceexampleUSCLSCodes
http://hl7.org/fhir/ValueSet/service-uscls
From the FHIR Standard
ClaimResponse.addItem.detail.subDetail.adjudication.categoryrequiredAdjudication
http://nphies.sa/terminology/ValueSet/adjudication
From this IG
ClaimResponse.addItem.detail.subDetail.adjudication.reasonrequiredAdjudicationReason(a valid code from Adjudication Reason)
http://nphies.sa/terminology/ValueSet/adjudication-reason
From this IG
ClaimResponse.total.categoryrequiredAdjudication
http://nphies.sa/terminology/ValueSet/adjudication
From this IG
ClaimResponse.fundsReserverequiredFunds Reservation Codes
http://hl7.org/fhir/ValueSet/fundsreserve
From the FHIR Standard
ClaimResponse.processNote.typerequiredNoteType
http://hl7.org/fhir/ValueSet/note-type|4.0.1
From the FHIR Standard
ClaimResponse.processNote.languagerequiredKSALanguages
http://nphies.sa/terminology/ValueSet/ksa-languages
From this IG

Constraints

IdGradePath(s)DetailsRequirements
BV-00569errorClaimResponseAdvanced preAuthorization- ClaimResponse use can only use the fixed value 'preauthorization'.
: use.exists() and use = 'preauthorization'
BV-00570errorClaimResponseAdvanced preAuthorization - ClaimResponse outcome can only be 'complete'.
: outcome.exists() and outcome = 'complete'
BV-00607errorClaimResponseClaimResponse status is not 'active'.
: status.exists() implies status = 'active'
BV-00609errorClaimResponseClaimResponse status is not 'active'.
: type.exists() implies (type = 'oral') implies subType.coding.first().code = 'op'
BV-00610errorClaimResponseClaimResponse status is not 'active'.
: type.exists() implies (type = 'vision') implies subType.coding.first().code = 'op'
BV-00611errorClaimResponseClaimResponse status is not 'active'.
: type.exists() implies (type = 'pharmacy') implies subType.coding.first().code = 'op'
BV-00614errorClaimResponse.addItemAdvanced preauthorization - The subSite shall not be allowed if the bodySite is not provided.
: subSite.exists() implies bodySite.exists()
dom-2errorClaimResponseIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorClaimResponseIf 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-4errorClaimResponseIf 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-5errorClaimResponseIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceClaimResponseA 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 ClaimResponse

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ClaimResponse C 0..* ClaimResponse Response to a claim predetermination or preauthorization
Constraints: BV-00569, BV-00570, BV-00607, BV-00609, BV-00610, BV-00611
... 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
... Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:reissue-reason S 0..1 CodeableConcept Adjudication Reissue Reason
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-adjudication-reissue
Binding: Reissue Reason (required)
.... extension:adjudication-outcome S 0..1 CodeableConcept Adjudication Outcome
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-adjudication-outcome
Binding: Adjudication Outcome (required)
.... extension:advancedAuth-reason 1..1 DP_CodeableConcept Advanced Auth Reason
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-advancedAuth-reason
Binding: Advanced Auth Reason (required)
.... extension:newborn S 0..1 boolean Newborn
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-newborn
.... extension:prescription S 0..1 DP_Reference_3aor4() Prescription Extension
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-prescription
.... extension:serviceProvider 1..1 DP_Reference_1or2a(Nphies Provider Organization) Service Provider Extension
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-serviceProvider
.... extension:referringProvider S 0..1 DP_Reference_1or2aor4(Nphies Provider Organization) Referring Provider Extension
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-referringProvider
.... extension:supportingInfo S 0..* (Complex) Supporting Info Extension
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-supportingInfo
.... extension:diagnosis 1..* (Complex) Diagnosis Extension
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-diagnosis
.... extension:transferAuthorizationNumber S 0..1 DP_string Transfer Authorization Number
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-transferAuthorizationNumber
.... extension:transferAuthorizationPeriod S 0..1 DP_Period_2 Transfer Authorization Period
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-transferAuthorizationPeriod
.... extension:transferAuthorizationProvider S 0..1 DP_Reference_1or4(Nphies Provider Organization | Nphies Practitioner) Transfer Authorization Provider
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-transferAuthorizationProvider
... status 1..1 DP_code active | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required)
Required Pattern: active
... type 1..1 DP_CodeableConcept More granular claim type
Binding: Claim Type Codes (required)
... subType 1..1 DP_CodeableConcept More granular claim type
Binding: Claim SubType (required)
... use 1..1 DP_code claim | preauthorization | predetermination
... patient 1..1 DP_Reference_1or2a(Nphies Patient) The recipient of the products and services
.... identifier
..... type 1..1 DP_CodeableConcept Description of identifier
Binding: Patient Identifier Type (required)
... created 1..1 DP_dateTime Response creation date
... insurer 1..1 DP_Reference_1or2a(Nphies Insurer Organization) Party responsible for reimbursement
... outcome 1..1 DP_code queued | complete | error | partial
... disposition S 0..1 DP_string Disposition Message
... preAuthRef S 0..1 DP_string Preauthorization reference
... preAuthPeriod S 0..1 DP_Period_2 Preauthorization reference effective period
... payeeType S 0..1 DP_CodeableConcept Party to be paid any benefits payable
Binding: Claim Payee Type Codes (required)
... addItem SC 0..* BackboneElement Insurer added line items
Constraints: BV-00614
.... Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:adjudication-outcome 1..1 CodeableConcept Adjudication Outcome
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-adjudication-outcome
Binding: Adjudication Outcome (required)
..... extension:sequence 1..1 DP_positiveInt Sequence Extension
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-sequence
..... extension:diagnosesSequence S 0..* DP_positiveInt Diagnosis Sequence Extension
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-diagnosis-sequence
..... extension:informationSequence S 0..* DP_positiveInt Information Sequence Extension
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-informationSequence
..... extension:package S 0..1 boolean Package Code
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-package
..... extension:maternity 1..1 boolean Maternity
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-maternity
.... provider 0..1 DP_Reference_1or2aor4(Nphies Practitioner) Authorized providers
.... productOrService 1..1 DP_CodeableConcept_2 Billing, service, product, or drug code
.... quantity S 0..1 DP_SimpleQuantity_1 Count of products or services
.... bodySite S 0..1 DP_CodeableConcept Anatomical location
.... subSite S 0..1 DP_CodeableConcept Anatomical sub-location
.... noteNumber S 0..* DP_positiveInt Applicable note numbers
.... adjudication 1..* BackboneElement Added items adjudication
..... category 1..1 DP_CodeableConcept Type of adjudication information
Binding: Adjudication (required)
..... reason S 0..1 DP_CodeableConcept Explanation of adjudication outcome
Binding: Adjudication Reason (required)
..... amount S 0..1 DP_Money_SAR Monetary amount
..... value S 0..1 DP_decimal Non-monetary value
.... detail S 0..* BackboneElement Insurer added line details
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:sequence 1..1 DP_positiveInt Sequence Extension
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-sequence
..... productOrService 1..1 DP_CodeableConcept_2 Billing, service, product, or drug code
..... quantity S 0..1 DP_SimpleQuantity_1 Count of products or services
..... noteNumber S 0..* DP_positiveInt Applicable note numbers
..... adjudication 1..* BackboneElement Added items detail adjudication
...... category 1..1 DP_CodeableConcept Type of adjudication information
Binding: Adjudication (required)
...... reason S 0..1 DP_CodeableConcept Explanation of adjudication outcome
Binding: Adjudication Reason (required)
...... amount S 0..1 DP_Money_SAR Monetary amount
...... value S 0..1 DP_decimal Non-monetary value
..... subDetail S 0..* BackboneElement Insurer added line items
...... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:sequence 1..1 DP_positiveInt Sequence Extension
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-sequence
...... productOrService 1..1 DP_CodeableConcept_2 Billing, service, product, or drug code
...... quantity S 0..1 DP_SimpleQuantity_1 Count of products or services
...... noteNumber S 0..* DP_positiveInt Applicable note numbers
...... adjudication 1..* BackboneElement Added items detail adjudication
....... category 1..1 DP_CodeableConcept Type of adjudication information
Binding: Adjudication (required)
....... reason S 0..1 DP_CodeableConcept Explanation of adjudication outcome
Binding: Adjudication Reason (required)
....... amount S 0..1 DP_Money_SAR Monetary amount
....... value S 0..1 DP_decimal Non-monetary value
... total S 0..* BackboneElement Adjudication totals
.... category 1..1 DP_CodeableConcept Type of adjudication information
Binding: Adjudication (required)
.... amount 1..1 DP_Money_SAR Financial total for the category
... fundsReserve S 0..1 CodeableConcept Funds reserved status
Binding: Funds Reservation Codes (required)
... processNote S 0..* BackboneElement Note concerning adjudication
.... number 1..1 DP_positiveInt Note instance identifier
.... type 1..1 DP_code display | print | printoper
.... text 1..1 DP_string Note explanatory text
.... language S 0..1 DP_CodeableConcept Language of the text
Binding: KSA Languages (required)
... insurance 1..* BackboneElement Patient insurance information
.... sequence 1..1 DP_positiveInt Insurance instance identifier
.... coverage 1..1 DP_Reference_1(Coverage) Insurance information

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / CodeURI
ClaimResponse.statusrequiredPattern Value: active
http://hl7.org/fhir/ValueSet/fm-status
From the FHIR Standard
ClaimResponse.typerequiredClaimTypeCodes
http://nphies.sa/terminology/ValueSet/claim-type
From this IG
ClaimResponse.subTyperequiredClaimSubType(a valid code from Claim SubType)
http://nphies.sa/terminology/ValueSet/claim-subtype
From this IG
ClaimResponse.patient.identifier.typerequiredPatientIdentifierType
http://nphies.sa/terminology/ValueSet/patient-identifier-type
From this IG
ClaimResponse.payeeTyperequiredClaim Payee Type Codes
http://hl7.org/fhir/ValueSet/payeetype
From the FHIR Standard
ClaimResponse.addItem.adjudication.categoryrequiredAdjudication
http://nphies.sa/terminology/ValueSet/adjudication
From this IG
ClaimResponse.addItem.adjudication.reasonrequiredAdjudicationReason(a valid code from Adjudication Reason)
http://nphies.sa/terminology/ValueSet/adjudication-reason
From this IG
ClaimResponse.addItem.detail.adjudication.categoryrequiredAdjudication
http://nphies.sa/terminology/ValueSet/adjudication
From this IG
ClaimResponse.addItem.detail.adjudication.reasonrequiredAdjudicationReason(a valid code from Adjudication Reason)
http://nphies.sa/terminology/ValueSet/adjudication-reason
From this IG
ClaimResponse.addItem.detail.subDetail.adjudication.categoryrequiredAdjudication
http://nphies.sa/terminology/ValueSet/adjudication
From this IG
ClaimResponse.addItem.detail.subDetail.adjudication.reasonrequiredAdjudicationReason(a valid code from Adjudication Reason)
http://nphies.sa/terminology/ValueSet/adjudication-reason
From this IG
ClaimResponse.total.categoryrequiredAdjudication
http://nphies.sa/terminology/ValueSet/adjudication
From this IG
ClaimResponse.fundsReserverequiredFunds Reservation Codes
http://hl7.org/fhir/ValueSet/fundsreserve
From the FHIR Standard
ClaimResponse.processNote.languagerequiredKSALanguages
http://nphies.sa/terminology/ValueSet/ksa-languages
From this IG

Constraints

IdGradePath(s)DetailsRequirements
BV-00569errorClaimResponseAdvanced preAuthorization- ClaimResponse use can only use the fixed value 'preauthorization'.
: use.exists() and use = 'preauthorization'
BV-00570errorClaimResponseAdvanced preAuthorization - ClaimResponse outcome can only be 'complete'.
: outcome.exists() and outcome = 'complete'
BV-00607errorClaimResponseClaimResponse status is not 'active'.
: status.exists() implies status = 'active'
BV-00609errorClaimResponseClaimResponse status is not 'active'.
: type.exists() implies (type = 'oral') implies subType.coding.first().code = 'op'
BV-00610errorClaimResponseClaimResponse status is not 'active'.
: type.exists() implies (type = 'vision') implies subType.coding.first().code = 'op'
BV-00611errorClaimResponseClaimResponse status is not 'active'.
: type.exists() implies (type = 'pharmacy') implies subType.coding.first().code = 'op'
BV-00614errorClaimResponse.addItemAdvanced preauthorization - The subSite shall not be allowed if the bodySite is not provided.
: subSite.exists() implies bodySite.exists()
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ClaimResponse C 0..* ClaimResponse Response to a claim predetermination or preauthorization
Constraints: BV-00569, BV-00570, BV-00607, BV-00609, BV-00610, BV-00611
... 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 BindingsPurpose
AllLanguages Max Binding
... 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
... Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:reissue-reason S 0..1 CodeableConcept Adjudication Reissue Reason
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-adjudication-reissue
Binding: Reissue Reason (required)
.... extension:adjudication-outcome S 0..1 CodeableConcept Adjudication Outcome
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-adjudication-outcome
Binding: Adjudication Outcome (required)
.... extension:advancedAuth-reason 1..1 DP_CodeableConcept Advanced Auth Reason
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-advancedAuth-reason
Binding: Advanced Auth Reason (required)
.... extension:newborn S 0..1 boolean Newborn
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-newborn
.... extension:prescription S 0..1 DP_Reference_3aor4() Prescription Extension
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-prescription
.... extension:serviceProvider 1..1 DP_Reference_1or2a(Nphies Provider Organization) Service Provider Extension
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-serviceProvider
.... extension:referringProvider S 0..1 DP_Reference_1or2aor4(Nphies Provider Organization) Referring Provider Extension
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-referringProvider
.... extension:supportingInfo S 0..* (Complex) Supporting Info Extension
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-supportingInfo
.... extension:diagnosis 1..* (Complex) Diagnosis Extension
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-diagnosis
.... extension:transferAuthorizationNumber S 0..1 DP_string Transfer Authorization Number
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-transferAuthorizationNumber
.... extension:transferAuthorizationPeriod S 0..1 DP_Period_2 Transfer Authorization Period
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-transferAuthorizationPeriod
.... extension:transferAuthorizationProvider S 0..1 DP_Reference_1or4(Nphies Provider Organization | Nphies Practitioner) Transfer Authorization Provider
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-transferAuthorizationProvider
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 1..1 DP_Identifier_A Business Identifier for a claim response
... status ?!Σ 1..1 DP_code active | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required)
Required Pattern: active
... type Σ 1..1 DP_CodeableConcept More granular claim type
Binding: Claim Type Codes (required)
... subType 1..1 DP_CodeableConcept More granular claim type
Binding: Claim SubType (required)
... use Σ 1..1 DP_code claim | preauthorization | predetermination
Binding: Use (required): Claim, preauthorization, predetermination.
... patient Σ 1..1 DP_Reference_1or2a(Nphies Patient) The recipient of the products and services
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣC 0..1 string Literal reference, Relative, internal or absolute URL
Max Length:250
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier SΣ 0..1 Identifier Logical reference, when literal reference is not known
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 1..1 DP_CodeableConcept Description of identifier
Binding: Patient Identifier Type (required)
..... system Σ 1..1 DP_uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
Max Length:50
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... display Σ 0..1 string Text alternative for the resource
Max Length:200
... created Σ 1..1 DP_dateTime Response creation date
... insurer Σ 1..1 DP_Reference_1or2a(Nphies Insurer Organization) Party responsible for reimbursement
... requestor 0..1 Reference(Practitioner | PractitionerRole | Organization) Party responsible for the claim
... request Σ 0..1 Reference(Claim) Id of resource triggering adjudication
... outcome Σ 1..1 DP_code queued | complete | error | partial
Binding: ClaimProcessingCodes (required): The result of the claim processing.
... disposition S 0..1 DP_string Disposition Message
... preAuthRef S 0..1 DP_string Preauthorization reference
... preAuthPeriod S 0..1 DP_Period_2 Preauthorization reference effective period
... payeeType S 0..1 DP_CodeableConcept Party to be paid any benefits payable
Binding: Claim Payee Type Codes (required)
... item 0..* BackboneElement Adjudication for claim line items
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... itemSequence 1..1 positiveInt Claim item instance identifier
.... noteNumber 0..* positiveInt Applicable note numbers
.... adjudication 1..* BackboneElement Adjudication details
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... category 1..1 CodeableConcept Type of adjudication information
Binding: AdjudicationValueCodes (example): The adjudication codes.
..... reason 0..1 CodeableConcept Explanation of adjudication outcome
Binding: AdjudicationReasonCodes (example): The adjudication reason codes.
..... amount 0..1 Money Monetary amount
..... value 0..1 decimal Non-monetary value
.... detail 0..* BackboneElement Adjudication for claim details
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... detailSequence 1..1 positiveInt Claim detail instance identifier
..... noteNumber 0..* positiveInt Applicable note numbers
..... adjudication 1..* See adjudication (ClaimResponse) Detail level adjudication details
..... subDetail 0..* BackboneElement Adjudication for claim sub-details
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... subDetailSequence 1..1 positiveInt Claim sub-detail instance identifier
...... noteNumber 0..* positiveInt Applicable note numbers
...... adjudication 0..* See adjudication (ClaimResponse) Subdetail level adjudication details
... addItem SC 0..* BackboneElement Insurer added line items
Constraints: BV-00614
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:adjudication-outcome 1..1 CodeableConcept Adjudication Outcome
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-adjudication-outcome
Binding: Adjudication Outcome (required)
..... extension:sequence 1..1 DP_positiveInt Sequence Extension
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-sequence
..... extension:diagnosesSequence S 0..* DP_positiveInt Diagnosis Sequence Extension
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-diagnosis-sequence
..... extension:informationSequence S 0..* DP_positiveInt Information Sequence Extension
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-informationSequence
..... extension:package S 0..1 boolean Package Code
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-package
..... extension:maternity 1..1 boolean Maternity
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-maternity
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... itemSequence 0..* positiveInt Item sequence number
.... detailSequence 0..* positiveInt Detail sequence number
.... subdetailSequence 0..* positiveInt Subdetail sequence number
.... provider 0..1 DP_Reference_1or2aor4(Nphies Practitioner) Authorized providers
.... productOrService 1..1 DP_CodeableConcept_2 Billing, service, product, or drug code
Binding: USCLSCodes (example): Allowable service and product codes.
.... modifier 0..* CodeableConcept Service/Product billing modifiers
Binding: ModifierTypeCodes (example): Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.
.... programCode 0..* CodeableConcept Program the product or service is provided under
Binding: ExampleProgramReasonCodes (example): Program specific reason codes.
.... serviced[x] 0..1 Date or dates of service or product delivery
..... servicedDate date
..... servicedPeriod Period
.... location[x] 0..1 Place of service or where product was supplied
Binding: ExampleServicePlaceCodes (example): Place of service: pharmacy, school, prison, etc.
..... locationCodeableConcept CodeableConcept
..... locationAddress Address
..... locationReference Reference(Location)
.... quantity S 0..1 DP_SimpleQuantity_1 Count of products or services
.... unitPrice 0..1 Money Fee, charge or cost per item
.... factor 0..1 decimal Price scaling factor
.... net 0..1 Money Total item cost
.... bodySite S 0..1 DP_CodeableConcept Anatomical location
Binding: OralSiteCodes (example): The code for the teeth, quadrant, sextant and arch.
.... subSite S 0..1 DP_CodeableConcept Anatomical sub-location
Binding: SurfaceCodes (example): The code for the tooth surface and surface combinations.
.... noteNumber S 0..* DP_positiveInt Applicable note numbers
.... adjudication 1..* BackboneElement Added items adjudication
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... category 1..1 DP_CodeableConcept Type of adjudication information
Binding: Adjudication (required)
..... reason S 0..1 DP_CodeableConcept Explanation of adjudication outcome
Binding: Adjudication Reason (required)
..... amount S 0..1 DP_Money_SAR Monetary amount
..... value S 0..1 DP_decimal Non-monetary value
.... detail S 0..* BackboneElement Insurer added line details
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:sequence 1..1 DP_positiveInt Sequence Extension
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-sequence
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... productOrService 1..1 DP_CodeableConcept_2 Billing, service, product, or drug code
Binding: USCLSCodes (example): Allowable service and product codes.
..... modifier 0..* CodeableConcept Service/Product billing modifiers
Binding: ModifierTypeCodes (example): Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.
..... quantity S 0..1 DP_SimpleQuantity_1 Count of products or services
..... unitPrice 0..1 Money Fee, charge or cost per item
..... factor 0..1 decimal Price scaling factor
..... net 0..1 Money Total item cost
..... noteNumber S 0..* DP_positiveInt Applicable note numbers
..... adjudication 1..* BackboneElement Added items detail adjudication
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... category 1..1 DP_CodeableConcept Type of adjudication information
Binding: Adjudication (required)
...... reason S 0..1 DP_CodeableConcept Explanation of adjudication outcome
Binding: Adjudication Reason (required)
...... amount S 0..1 DP_Money_SAR Monetary amount
...... value S 0..1 DP_decimal Non-monetary value
..... subDetail S 0..* BackboneElement Insurer added line items
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:sequence 1..1 DP_positiveInt Sequence Extension
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-sequence
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... productOrService 1..1 DP_CodeableConcept_2 Billing, service, product, or drug code
Binding: USCLSCodes (example): Allowable service and product codes.
...... modifier 0..* CodeableConcept Service/Product billing modifiers
Binding: ModifierTypeCodes (example): Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.
...... quantity S 0..1 DP_SimpleQuantity_1 Count of products or services
...... unitPrice 0..1 Money Fee, charge or cost per item
...... factor 0..1 decimal Price scaling factor
...... net 0..1 Money Total item cost
...... noteNumber S 0..* DP_positiveInt Applicable note numbers
...... adjudication 1..* BackboneElement Added items detail adjudication
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... category 1..1 DP_CodeableConcept Type of adjudication information
Binding: Adjudication (required)
....... reason S 0..1 DP_CodeableConcept Explanation of adjudication outcome
Binding: Adjudication Reason (required)
....... amount S 0..1 DP_Money_SAR Monetary amount
....... value S 0..1 DP_decimal Non-monetary value
... adjudication 0..* See adjudication (ClaimResponse) Header-level adjudication
... total SΣ 0..* BackboneElement Adjudication totals
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... category Σ 1..1 DP_CodeableConcept Type of adjudication information
Binding: Adjudication (required)
.... amount Σ 1..1 DP_Money_SAR Financial total for the category
... payment 0..1 BackboneElement Payment Details
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 1..1 CodeableConcept Partial or complete payment
Binding: ExamplePaymentTypeCodes (example): The type (partial, complete) of the payment.
.... adjustment 0..1 Money Payment adjustment for non-claim issues
.... adjustmentReason 0..1 CodeableConcept Explanation for the adjustment
Binding: PaymentAdjustmentReasonCodes (example): Payment Adjustment reason codes.
.... date 0..1 date Expected date of payment
.... amount 1..1 Money Payable amount after adjustment
.... identifier 0..1 Identifier Business identifier for the payment
... fundsReserve S 0..1 CodeableConcept Funds reserved status
Binding: Funds Reservation Codes (required)
... formCode 0..1 CodeableConcept Printed form identifier
Binding: Form Codes (example): The forms codes.
... form 0..1 Attachment Printed reference or actual form
... processNote S 0..* BackboneElement Note concerning adjudication
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... number 1..1 DP_positiveInt Note instance identifier
.... type 1..1 DP_code display | print | printoper
Binding: NoteType (required): The presentation types of notes.
.... text 1..1 DP_string Note explanatory text
.... language S 0..1 DP_CodeableConcept Language of the text
Binding: KSA Languages (required)
... communicationRequest 0..* Reference(CommunicationRequest) Request for additional information
... insurance 1..* BackboneElement Patient insurance information
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... sequence 1..1 DP_positiveInt Insurance instance identifier
.... focal 1..1 boolean Coverage to be used for adjudication
.... coverage 1..1 DP_Reference_1(Coverage) Insurance information
.... businessArrangement 0..1 string Additional provider contract number
.... claimResponse 0..1 Reference(ClaimResponse) Adjudication results
... error 0..* BackboneElement Processing errors
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... itemSequence 0..1 positiveInt Item sequence number
.... detailSequence 0..1 positiveInt Detail sequence number
.... subDetailSequence 0..1 positiveInt Subdetail sequence number
.... code 1..1 CodeableConcept Error code detailing processing issues
Binding: Adjudication Error Codes (example): The adjudication error codes.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ClaimResponse.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
From the FHIR Standard
ClaimResponse.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
From the FHIR Standard
ClaimResponse.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
ClaimResponse.statusrequiredPattern Value: active
http://hl7.org/fhir/ValueSet/fm-status
From the FHIR Standard
ClaimResponse.typerequiredClaimTypeCodes
http://nphies.sa/terminology/ValueSet/claim-type
From this IG
ClaimResponse.subTyperequiredClaimSubType(a valid code from Claim SubType)
http://nphies.sa/terminology/ValueSet/claim-subtype
From this IG
ClaimResponse.userequiredUse
http://hl7.org/fhir/ValueSet/claim-use|4.0.1
From the FHIR Standard
ClaimResponse.patient.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
ClaimResponse.patient.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
ClaimResponse.patient.identifier.typerequiredPatientIdentifierType
http://nphies.sa/terminology/ValueSet/patient-identifier-type
From this IG
ClaimResponse.outcomerequiredClaimProcessingCodes
http://hl7.org/fhir/ValueSet/remittance-outcome|4.0.1
From the FHIR Standard
ClaimResponse.payeeTyperequiredClaim Payee Type Codes
http://hl7.org/fhir/ValueSet/payeetype
From the FHIR Standard
ClaimResponse.item.adjudication.categoryexampleAdjudicationValueCodes
http://hl7.org/fhir/ValueSet/adjudication
From the FHIR Standard
ClaimResponse.item.adjudication.reasonexampleAdjudicationReasonCodes
http://hl7.org/fhir/ValueSet/adjudication-reason
From the FHIR Standard
ClaimResponse.addItem.productOrServiceexampleUSCLSCodes
http://hl7.org/fhir/ValueSet/service-uscls
From the FHIR Standard
ClaimResponse.addItem.modifierexampleModifierTypeCodes
http://hl7.org/fhir/ValueSet/claim-modifiers
From the FHIR Standard
ClaimResponse.addItem.programCodeexampleExampleProgramReasonCodes
http://hl7.org/fhir/ValueSet/ex-program-code
From the FHIR Standard
ClaimResponse.addItem.location[x]exampleExampleServicePlaceCodes
http://hl7.org/fhir/ValueSet/service-place
From the FHIR Standard
ClaimResponse.addItem.bodySiteexampleOralSiteCodes
http://hl7.org/fhir/ValueSet/tooth
From the FHIR Standard
ClaimResponse.addItem.subSiteexampleSurfaceCodes
http://hl7.org/fhir/ValueSet/surface
From the FHIR Standard
ClaimResponse.addItem.adjudication.categoryrequiredAdjudication
http://nphies.sa/terminology/ValueSet/adjudication
From this IG
ClaimResponse.addItem.adjudication.reasonrequiredAdjudicationReason(a valid code from Adjudication Reason)
http://nphies.sa/terminology/ValueSet/adjudication-reason
From this IG
ClaimResponse.addItem.detail.productOrServiceexampleUSCLSCodes
http://hl7.org/fhir/ValueSet/service-uscls
From the FHIR Standard
ClaimResponse.addItem.detail.modifierexampleModifierTypeCodes
http://hl7.org/fhir/ValueSet/claim-modifiers
From the FHIR Standard
ClaimResponse.addItem.detail.adjudication.categoryrequiredAdjudication
http://nphies.sa/terminology/ValueSet/adjudication
From this IG
ClaimResponse.addItem.detail.adjudication.reasonrequiredAdjudicationReason(a valid code from Adjudication Reason)
http://nphies.sa/terminology/ValueSet/adjudication-reason
From this IG
ClaimResponse.addItem.detail.subDetail.productOrServiceexampleUSCLSCodes
http://hl7.org/fhir/ValueSet/service-uscls
From the FHIR Standard
ClaimResponse.addItem.detail.subDetail.modifierexampleModifierTypeCodes
http://hl7.org/fhir/ValueSet/claim-modifiers
From the FHIR Standard
ClaimResponse.addItem.detail.subDetail.adjudication.categoryrequiredAdjudication
http://nphies.sa/terminology/ValueSet/adjudication
From this IG
ClaimResponse.addItem.detail.subDetail.adjudication.reasonrequiredAdjudicationReason(a valid code from Adjudication Reason)
http://nphies.sa/terminology/ValueSet/adjudication-reason
From this IG
ClaimResponse.total.categoryrequiredAdjudication
http://nphies.sa/terminology/ValueSet/adjudication
From this IG
ClaimResponse.payment.typeexampleExamplePaymentTypeCodes
http://hl7.org/fhir/ValueSet/ex-paymenttype
From the FHIR Standard
ClaimResponse.payment.adjustmentReasonexamplePaymentAdjustmentReasonCodes
http://hl7.org/fhir/ValueSet/payment-adjustment-reason
From the FHIR Standard
ClaimResponse.fundsReserverequiredFunds Reservation Codes
http://hl7.org/fhir/ValueSet/fundsreserve
From the FHIR Standard
ClaimResponse.formCodeexampleForm Codes
http://hl7.org/fhir/ValueSet/forms
From the FHIR Standard
ClaimResponse.processNote.typerequiredNoteType
http://hl7.org/fhir/ValueSet/note-type|4.0.1
From the FHIR Standard
ClaimResponse.processNote.languagerequiredKSALanguages
http://nphies.sa/terminology/ValueSet/ksa-languages
From this IG
ClaimResponse.error.codeexampleAdjudication Error Codes
http://hl7.org/fhir/ValueSet/adjudication-error
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
BV-00569errorClaimResponseAdvanced preAuthorization- ClaimResponse use can only use the fixed value 'preauthorization'.
: use.exists() and use = 'preauthorization'
BV-00570errorClaimResponseAdvanced preAuthorization - ClaimResponse outcome can only be 'complete'.
: outcome.exists() and outcome = 'complete'
BV-00607errorClaimResponseClaimResponse status is not 'active'.
: status.exists() implies status = 'active'
BV-00609errorClaimResponseClaimResponse status is not 'active'.
: type.exists() implies (type = 'oral') implies subType.coding.first().code = 'op'
BV-00610errorClaimResponseClaimResponse status is not 'active'.
: type.exists() implies (type = 'vision') implies subType.coding.first().code = 'op'
BV-00611errorClaimResponseClaimResponse status is not 'active'.
: type.exists() implies (type = 'pharmacy') implies subType.coding.first().code = 'op'
BV-00614errorClaimResponse.addItemAdvanced preauthorization - The subSite shall not be allowed if the bodySite is not provided.
: subSite.exists() implies bodySite.exists()
dom-2errorClaimResponseIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorClaimResponseIf 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-4errorClaimResponseIf 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-5errorClaimResponseIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceClaimResponseA 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 ClaimResponse

Summary

Mandatory: 9 elements(9 nested mandatory elements)
Must-Support: 40 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ClaimResponse C 0..* ClaimResponse Response to a claim predetermination or preauthorization
Constraints: BV-00569, BV-00570, BV-00607, BV-00609, BV-00610, BV-00611
... 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
.... extension:reissue-reason S 0..1 CodeableConcept Adjudication Reissue Reason
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-adjudication-reissue
Binding: Reissue Reason (required)
.... extension:adjudication-outcome S 0..1 CodeableConcept Adjudication Outcome
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-adjudication-outcome
Binding: Adjudication Outcome (required)
.... extension:advancedAuth-reason 1..1 DP_CodeableConcept Advanced Auth Reason
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-advancedAuth-reason
Binding: Advanced Auth Reason (required)
.... extension:newborn S 0..1 boolean Newborn
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-newborn
.... extension:prescription S 0..1 DP_Reference_3aor4() Prescription Extension
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-prescription
.... extension:serviceProvider 1..1 DP_Reference_1or2a(Nphies Provider Organization) Service Provider Extension
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-serviceProvider
.... extension:referringProvider S 0..1 DP_Reference_1or2aor4(Nphies Provider Organization) Referring Provider Extension
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-referringProvider
.... extension:supportingInfo S 0..* (Complex) Supporting Info Extension
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-supportingInfo
.... extension:diagnosis 1..* (Complex) Diagnosis Extension
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-diagnosis
.... extension:transferAuthorizationNumber S 0..1 DP_string Transfer Authorization Number
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-transferAuthorizationNumber
.... extension:transferAuthorizationPeriod S 0..1 DP_Period_2 Transfer Authorization Period
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-transferAuthorizationPeriod
.... extension:transferAuthorizationProvider S 0..1 DP_Reference_1or4(Nphies Provider Organization | Nphies Practitioner) Transfer Authorization Provider
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-transferAuthorizationProvider
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 1..1 DP_Identifier_A Business Identifier for a claim response
... status ?!Σ 1..1 DP_code active | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required)
Required Pattern: active
... type Σ 1..1 DP_CodeableConcept More granular claim type
Binding: Claim Type Codes (required)
... subType 1..1 DP_CodeableConcept More granular claim type
Binding: Claim SubType (required)
... use Σ 1..1 DP_code claim | preauthorization | predetermination
Binding: Use (required): Claim, preauthorization, predetermination.
... patient Σ 1..1 DP_Reference_1or2a(Nphies Patient) The recipient of the products and services
.... reference SΣC 0..1 string Literal reference, Relative, internal or absolute URL
Max Length:250
.... identifier SΣ 0..1 Identifier Logical reference, when literal reference is not known
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 1..1 DP_CodeableConcept Description of identifier
Binding: Patient Identifier Type (required)
..... system Σ 1..1 DP_uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
Max Length:50
.... display Σ 0..1 string Text alternative for the resource
Max Length:200
... created Σ 1..1 DP_dateTime Response creation date
... insurer Σ 1..1 DP_Reference_1or2a(Nphies Insurer Organization) Party responsible for reimbursement
... outcome Σ 1..1 DP_code queued | complete | error | partial
Binding: ClaimProcessingCodes (required): The result of the claim processing.
... disposition S 0..1 DP_string Disposition Message
... preAuthRef S 0..1 DP_string Preauthorization reference
... preAuthPeriod S 0..1 DP_Period_2 Preauthorization reference effective period
... payeeType S 0..1 DP_CodeableConcept Party to be paid any benefits payable
Binding: Claim Payee Type Codes (required)
... addItem SC 0..* BackboneElement Insurer added line items
Constraints: BV-00614
.... Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:adjudication-outcome 1..1 CodeableConcept Adjudication Outcome
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-adjudication-outcome
Binding: Adjudication Outcome (required)
..... extension:sequence 1..1 DP_positiveInt Sequence Extension
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-sequence
..... extension:diagnosesSequence S 0..* DP_positiveInt Diagnosis Sequence Extension
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-diagnosis-sequence
..... extension:informationSequence S 0..* DP_positiveInt Information Sequence Extension
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-informationSequence
..... extension:package S 0..1 boolean Package Code
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-package
..... extension:maternity 1..1 boolean Maternity
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-maternity
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... provider 0..1 DP_Reference_1or2aor4(Nphies Practitioner) Authorized providers
.... productOrService 1..1 DP_CodeableConcept_2 Billing, service, product, or drug code
Binding: USCLSCodes (example): Allowable service and product codes.
.... quantity S 0..1 DP_SimpleQuantity_1 Count of products or services
.... bodySite S 0..1 DP_CodeableConcept Anatomical location
Binding: OralSiteCodes (example): The code for the teeth, quadrant, sextant and arch.
.... subSite S 0..1 DP_CodeableConcept Anatomical sub-location
Binding: SurfaceCodes (example): The code for the tooth surface and surface combinations.
.... noteNumber S 0..* DP_positiveInt Applicable note numbers
.... adjudication 1..* BackboneElement Added items adjudication
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... category 1..1 DP_CodeableConcept Type of adjudication information
Binding: Adjudication (required)
..... reason S 0..1 DP_CodeableConcept Explanation of adjudication outcome
Binding: Adjudication Reason (required)
..... amount S 0..1 DP_Money_SAR Monetary amount
..... value S 0..1 DP_decimal Non-monetary value
.... detail S 0..* BackboneElement Insurer added line details
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:sequence 1..1 DP_positiveInt Sequence Extension
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-sequence
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... productOrService 1..1 DP_CodeableConcept_2 Billing, service, product, or drug code
Binding: USCLSCodes (example): Allowable service and product codes.
..... quantity S 0..1 DP_SimpleQuantity_1 Count of products or services
..... noteNumber S 0..* DP_positiveInt Applicable note numbers
..... adjudication 1..* BackboneElement Added items detail adjudication
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... category 1..1 DP_CodeableConcept Type of adjudication information
Binding: Adjudication (required)
...... reason S 0..1 DP_CodeableConcept Explanation of adjudication outcome
Binding: Adjudication Reason (required)
...... amount S 0..1 DP_Money_SAR Monetary amount
...... value S 0..1 DP_decimal Non-monetary value
..... subDetail S 0..* BackboneElement Insurer added line items
...... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:sequence 1..1 DP_positiveInt Sequence Extension
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-sequence
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... productOrService 1..1 DP_CodeableConcept_2 Billing, service, product, or drug code
Binding: USCLSCodes (example): Allowable service and product codes.
...... quantity S 0..1 DP_SimpleQuantity_1 Count of products or services
...... noteNumber S 0..* DP_positiveInt Applicable note numbers
...... adjudication 1..* BackboneElement Added items detail adjudication
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... category 1..1 DP_CodeableConcept Type of adjudication information
Binding: Adjudication (required)
....... reason S 0..1 DP_CodeableConcept Explanation of adjudication outcome
Binding: Adjudication Reason (required)
....... amount S 0..1 DP_Money_SAR Monetary amount
....... value S 0..1 DP_decimal Non-monetary value
... total SΣ 0..* BackboneElement Adjudication totals
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... category Σ 1..1 DP_CodeableConcept Type of adjudication information
Binding: Adjudication (required)
.... amount Σ 1..1 DP_Money_SAR Financial total for the category
... fundsReserve S 0..1 CodeableConcept Funds reserved status
Binding: Funds Reservation Codes (required)
... processNote S 0..* BackboneElement Note concerning adjudication
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... number 1..1 DP_positiveInt Note instance identifier
.... type 1..1 DP_code display | print | printoper
Binding: NoteType (required): The presentation types of notes.
.... text 1..1 DP_string Note explanatory text
.... language S 0..1 DP_CodeableConcept Language of the text
Binding: KSA Languages (required)
... insurance 1..* BackboneElement Patient insurance information
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... sequence 1..1 DP_positiveInt Insurance instance identifier
.... focal 1..1 boolean Coverage to be used for adjudication
.... coverage 1..1 DP_Reference_1(Coverage) Insurance information

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ClaimResponse.statusrequiredPattern Value: active
http://hl7.org/fhir/ValueSet/fm-status
From the FHIR Standard
ClaimResponse.typerequiredClaimTypeCodes
http://nphies.sa/terminology/ValueSet/claim-type
From this IG
ClaimResponse.subTyperequiredClaimSubType(a valid code from Claim SubType)
http://nphies.sa/terminology/ValueSet/claim-subtype
From this IG
ClaimResponse.userequiredUse
http://hl7.org/fhir/ValueSet/claim-use|4.0.1
From the FHIR Standard
ClaimResponse.patient.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
ClaimResponse.patient.identifier.typerequiredPatientIdentifierType
http://nphies.sa/terminology/ValueSet/patient-identifier-type
From this IG
ClaimResponse.outcomerequiredClaimProcessingCodes
http://hl7.org/fhir/ValueSet/remittance-outcome|4.0.1
From the FHIR Standard
ClaimResponse.payeeTyperequiredClaim Payee Type Codes
http://hl7.org/fhir/ValueSet/payeetype
From the FHIR Standard
ClaimResponse.addItem.productOrServiceexampleUSCLSCodes
http://hl7.org/fhir/ValueSet/service-uscls
From the FHIR Standard
ClaimResponse.addItem.bodySiteexampleOralSiteCodes
http://hl7.org/fhir/ValueSet/tooth
From the FHIR Standard
ClaimResponse.addItem.subSiteexampleSurfaceCodes
http://hl7.org/fhir/ValueSet/surface
From the FHIR Standard
ClaimResponse.addItem.adjudication.categoryrequiredAdjudication
http://nphies.sa/terminology/ValueSet/adjudication
From this IG
ClaimResponse.addItem.adjudication.reasonrequiredAdjudicationReason(a valid code from Adjudication Reason)
http://nphies.sa/terminology/ValueSet/adjudication-reason
From this IG
ClaimResponse.addItem.detail.productOrServiceexampleUSCLSCodes
http://hl7.org/fhir/ValueSet/service-uscls
From the FHIR Standard
ClaimResponse.addItem.detail.adjudication.categoryrequiredAdjudication
http://nphies.sa/terminology/ValueSet/adjudication
From this IG
ClaimResponse.addItem.detail.adjudication.reasonrequiredAdjudicationReason(a valid code from Adjudication Reason)
http://nphies.sa/terminology/ValueSet/adjudication-reason
From this IG
ClaimResponse.addItem.detail.subDetail.productOrServiceexampleUSCLSCodes
http://hl7.org/fhir/ValueSet/service-uscls
From the FHIR Standard
ClaimResponse.addItem.detail.subDetail.adjudication.categoryrequiredAdjudication
http://nphies.sa/terminology/ValueSet/adjudication
From this IG
ClaimResponse.addItem.detail.subDetail.adjudication.reasonrequiredAdjudicationReason(a valid code from Adjudication Reason)
http://nphies.sa/terminology/ValueSet/adjudication-reason
From this IG
ClaimResponse.total.categoryrequiredAdjudication
http://nphies.sa/terminology/ValueSet/adjudication
From this IG
ClaimResponse.fundsReserverequiredFunds Reservation Codes
http://hl7.org/fhir/ValueSet/fundsreserve
From the FHIR Standard
ClaimResponse.processNote.typerequiredNoteType
http://hl7.org/fhir/ValueSet/note-type|4.0.1
From the FHIR Standard
ClaimResponse.processNote.languagerequiredKSALanguages
http://nphies.sa/terminology/ValueSet/ksa-languages
From this IG

Constraints

IdGradePath(s)DetailsRequirements
BV-00569errorClaimResponseAdvanced preAuthorization- ClaimResponse use can only use the fixed value 'preauthorization'.
: use.exists() and use = 'preauthorization'
BV-00570errorClaimResponseAdvanced preAuthorization - ClaimResponse outcome can only be 'complete'.
: outcome.exists() and outcome = 'complete'
BV-00607errorClaimResponseClaimResponse status is not 'active'.
: status.exists() implies status = 'active'
BV-00609errorClaimResponseClaimResponse status is not 'active'.
: type.exists() implies (type = 'oral') implies subType.coding.first().code = 'op'
BV-00610errorClaimResponseClaimResponse status is not 'active'.
: type.exists() implies (type = 'vision') implies subType.coding.first().code = 'op'
BV-00611errorClaimResponseClaimResponse status is not 'active'.
: type.exists() implies (type = 'pharmacy') implies subType.coding.first().code = 'op'
BV-00614errorClaimResponse.addItemAdvanced preauthorization - The subSite shall not be allowed if the bodySite is not provided.
: subSite.exists() implies bodySite.exists()
dom-2errorClaimResponseIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorClaimResponseIf 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-4errorClaimResponseIf 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-5errorClaimResponseIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceClaimResponseA 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 ClaimResponse

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ClaimResponse C 0..* ClaimResponse Response to a claim predetermination or preauthorization
Constraints: BV-00569, BV-00570, BV-00607, BV-00609, BV-00610, BV-00611
... 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
... Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:reissue-reason S 0..1 CodeableConcept Adjudication Reissue Reason
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-adjudication-reissue
Binding: Reissue Reason (required)
.... extension:adjudication-outcome S 0..1 CodeableConcept Adjudication Outcome
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-adjudication-outcome
Binding: Adjudication Outcome (required)
.... extension:advancedAuth-reason 1..1 DP_CodeableConcept Advanced Auth Reason
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-advancedAuth-reason
Binding: Advanced Auth Reason (required)
.... extension:newborn S 0..1 boolean Newborn
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-newborn
.... extension:prescription S 0..1 DP_Reference_3aor4() Prescription Extension
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-prescription
.... extension:serviceProvider 1..1 DP_Reference_1or2a(Nphies Provider Organization) Service Provider Extension
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-serviceProvider
.... extension:referringProvider S 0..1 DP_Reference_1or2aor4(Nphies Provider Organization) Referring Provider Extension
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-referringProvider
.... extension:supportingInfo S 0..* (Complex) Supporting Info Extension
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-supportingInfo
.... extension:diagnosis 1..* (Complex) Diagnosis Extension
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-diagnosis
.... extension:transferAuthorizationNumber S 0..1 DP_string Transfer Authorization Number
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-transferAuthorizationNumber
.... extension:transferAuthorizationPeriod S 0..1 DP_Period_2 Transfer Authorization Period
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-transferAuthorizationPeriod
.... extension:transferAuthorizationProvider S 0..1 DP_Reference_1or4(Nphies Provider Organization | Nphies Practitioner) Transfer Authorization Provider
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-transferAuthorizationProvider
... status 1..1 DP_code active | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required)
Required Pattern: active
... type 1..1 DP_CodeableConcept More granular claim type
Binding: Claim Type Codes (required)
... subType 1..1 DP_CodeableConcept More granular claim type
Binding: Claim SubType (required)
... use 1..1 DP_code claim | preauthorization | predetermination
... patient 1..1 DP_Reference_1or2a(Nphies Patient) The recipient of the products and services
.... identifier
..... type 1..1 DP_CodeableConcept Description of identifier
Binding: Patient Identifier Type (required)
... created 1..1 DP_dateTime Response creation date
... insurer 1..1 DP_Reference_1or2a(Nphies Insurer Organization) Party responsible for reimbursement
... outcome 1..1 DP_code queued | complete | error | partial
... disposition S 0..1 DP_string Disposition Message
... preAuthRef S 0..1 DP_string Preauthorization reference
... preAuthPeriod S 0..1 DP_Period_2 Preauthorization reference effective period
... payeeType S 0..1 DP_CodeableConcept Party to be paid any benefits payable
Binding: Claim Payee Type Codes (required)
... addItem SC 0..* BackboneElement Insurer added line items
Constraints: BV-00614
.... Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:adjudication-outcome 1..1 CodeableConcept Adjudication Outcome
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-adjudication-outcome
Binding: Adjudication Outcome (required)
..... extension:sequence 1..1 DP_positiveInt Sequence Extension
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-sequence
..... extension:diagnosesSequence S 0..* DP_positiveInt Diagnosis Sequence Extension
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-diagnosis-sequence
..... extension:informationSequence S 0..* DP_positiveInt Information Sequence Extension
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-informationSequence
..... extension:package S 0..1 boolean Package Code
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-package
..... extension:maternity 1..1 boolean Maternity
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-maternity
.... provider 0..1 DP_Reference_1or2aor4(Nphies Practitioner) Authorized providers
.... productOrService 1..1 DP_CodeableConcept_2 Billing, service, product, or drug code
.... quantity S 0..1 DP_SimpleQuantity_1 Count of products or services
.... bodySite S 0..1 DP_CodeableConcept Anatomical location
.... subSite S 0..1 DP_CodeableConcept Anatomical sub-location
.... noteNumber S 0..* DP_positiveInt Applicable note numbers
.... adjudication 1..* BackboneElement Added items adjudication
..... category 1..1 DP_CodeableConcept Type of adjudication information
Binding: Adjudication (required)
..... reason S 0..1 DP_CodeableConcept Explanation of adjudication outcome
Binding: Adjudication Reason (required)
..... amount S 0..1 DP_Money_SAR Monetary amount
..... value S 0..1 DP_decimal Non-monetary value
.... detail S 0..* BackboneElement Insurer added line details
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:sequence 1..1 DP_positiveInt Sequence Extension
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-sequence
..... productOrService 1..1 DP_CodeableConcept_2 Billing, service, product, or drug code
..... quantity S 0..1 DP_SimpleQuantity_1 Count of products or services
..... noteNumber S 0..* DP_positiveInt Applicable note numbers
..... adjudication 1..* BackboneElement Added items detail adjudication
...... category 1..1 DP_CodeableConcept Type of adjudication information
Binding: Adjudication (required)
...... reason S 0..1 DP_CodeableConcept Explanation of adjudication outcome
Binding: Adjudication Reason (required)
...... amount S 0..1 DP_Money_SAR Monetary amount
...... value S 0..1 DP_decimal Non-monetary value
..... subDetail S 0..* BackboneElement Insurer added line items
...... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:sequence 1..1 DP_positiveInt Sequence Extension
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-sequence
...... productOrService 1..1 DP_CodeableConcept_2 Billing, service, product, or drug code
...... quantity S 0..1 DP_SimpleQuantity_1 Count of products or services
...... noteNumber S 0..* DP_positiveInt Applicable note numbers
...... adjudication 1..* BackboneElement Added items detail adjudication
....... category 1..1 DP_CodeableConcept Type of adjudication information
Binding: Adjudication (required)
....... reason S 0..1 DP_CodeableConcept Explanation of adjudication outcome
Binding: Adjudication Reason (required)
....... amount S 0..1 DP_Money_SAR Monetary amount
....... value S 0..1 DP_decimal Non-monetary value
... total S 0..* BackboneElement Adjudication totals
.... category 1..1 DP_CodeableConcept Type of adjudication information
Binding: Adjudication (required)
.... amount 1..1 DP_Money_SAR Financial total for the category
... fundsReserve S 0..1 CodeableConcept Funds reserved status
Binding: Funds Reservation Codes (required)
... processNote S 0..* BackboneElement Note concerning adjudication
.... number 1..1 DP_positiveInt Note instance identifier
.... type 1..1 DP_code display | print | printoper
.... text 1..1 DP_string Note explanatory text
.... language S 0..1 DP_CodeableConcept Language of the text
Binding: KSA Languages (required)
... insurance 1..* BackboneElement Patient insurance information
.... sequence 1..1 DP_positiveInt Insurance instance identifier
.... coverage 1..1 DP_Reference_1(Coverage) Insurance information

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / CodeURI
ClaimResponse.statusrequiredPattern Value: active
http://hl7.org/fhir/ValueSet/fm-status
From the FHIR Standard
ClaimResponse.typerequiredClaimTypeCodes
http://nphies.sa/terminology/ValueSet/claim-type
From this IG
ClaimResponse.subTyperequiredClaimSubType(a valid code from Claim SubType)
http://nphies.sa/terminology/ValueSet/claim-subtype
From this IG
ClaimResponse.patient.identifier.typerequiredPatientIdentifierType
http://nphies.sa/terminology/ValueSet/patient-identifier-type
From this IG
ClaimResponse.payeeTyperequiredClaim Payee Type Codes
http://hl7.org/fhir/ValueSet/payeetype
From the FHIR Standard
ClaimResponse.addItem.adjudication.categoryrequiredAdjudication
http://nphies.sa/terminology/ValueSet/adjudication
From this IG
ClaimResponse.addItem.adjudication.reasonrequiredAdjudicationReason(a valid code from Adjudication Reason)
http://nphies.sa/terminology/ValueSet/adjudication-reason
From this IG
ClaimResponse.addItem.detail.adjudication.categoryrequiredAdjudication
http://nphies.sa/terminology/ValueSet/adjudication
From this IG
ClaimResponse.addItem.detail.adjudication.reasonrequiredAdjudicationReason(a valid code from Adjudication Reason)
http://nphies.sa/terminology/ValueSet/adjudication-reason
From this IG
ClaimResponse.addItem.detail.subDetail.adjudication.categoryrequiredAdjudication
http://nphies.sa/terminology/ValueSet/adjudication
From this IG
ClaimResponse.addItem.detail.subDetail.adjudication.reasonrequiredAdjudicationReason(a valid code from Adjudication Reason)
http://nphies.sa/terminology/ValueSet/adjudication-reason
From this IG
ClaimResponse.total.categoryrequiredAdjudication
http://nphies.sa/terminology/ValueSet/adjudication
From this IG
ClaimResponse.fundsReserverequiredFunds Reservation Codes
http://hl7.org/fhir/ValueSet/fundsreserve
From the FHIR Standard
ClaimResponse.processNote.languagerequiredKSALanguages
http://nphies.sa/terminology/ValueSet/ksa-languages
From this IG

Constraints

IdGradePath(s)DetailsRequirements
BV-00569errorClaimResponseAdvanced preAuthorization- ClaimResponse use can only use the fixed value 'preauthorization'.
: use.exists() and use = 'preauthorization'
BV-00570errorClaimResponseAdvanced preAuthorization - ClaimResponse outcome can only be 'complete'.
: outcome.exists() and outcome = 'complete'
BV-00607errorClaimResponseClaimResponse status is not 'active'.
: status.exists() implies status = 'active'
BV-00609errorClaimResponseClaimResponse status is not 'active'.
: type.exists() implies (type = 'oral') implies subType.coding.first().code = 'op'
BV-00610errorClaimResponseClaimResponse status is not 'active'.
: type.exists() implies (type = 'vision') implies subType.coding.first().code = 'op'
BV-00611errorClaimResponseClaimResponse status is not 'active'.
: type.exists() implies (type = 'pharmacy') implies subType.coding.first().code = 'op'
BV-00614errorClaimResponse.addItemAdvanced preauthorization - The subSite shall not be allowed if the bodySite is not provided.
: subSite.exists() implies bodySite.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ClaimResponse C 0..* ClaimResponse Response to a claim predetermination or preauthorization
Constraints: BV-00569, BV-00570, BV-00607, BV-00609, BV-00610, BV-00611
... 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 BindingsPurpose
AllLanguages Max Binding
... 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
... Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:reissue-reason S 0..1 CodeableConcept Adjudication Reissue Reason
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-adjudication-reissue
Binding: Reissue Reason (required)
.... extension:adjudication-outcome S 0..1 CodeableConcept Adjudication Outcome
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-adjudication-outcome
Binding: Adjudication Outcome (required)
.... extension:advancedAuth-reason 1..1 DP_CodeableConcept Advanced Auth Reason
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-advancedAuth-reason
Binding: Advanced Auth Reason (required)
.... extension:newborn S 0..1 boolean Newborn
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-newborn
.... extension:prescription S 0..1 DP_Reference_3aor4() Prescription Extension
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-prescription
.... extension:serviceProvider 1..1 DP_Reference_1or2a(Nphies Provider Organization) Service Provider Extension
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-serviceProvider
.... extension:referringProvider S 0..1 DP_Reference_1or2aor4(Nphies Provider Organization) Referring Provider Extension
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-referringProvider
.... extension:supportingInfo S 0..* (Complex) Supporting Info Extension
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-supportingInfo
.... extension:diagnosis 1..* (Complex) Diagnosis Extension
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-diagnosis
.... extension:transferAuthorizationNumber S 0..1 DP_string Transfer Authorization Number
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-transferAuthorizationNumber
.... extension:transferAuthorizationPeriod S 0..1 DP_Period_2 Transfer Authorization Period
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-transferAuthorizationPeriod
.... extension:transferAuthorizationProvider S 0..1 DP_Reference_1or4(Nphies Provider Organization | Nphies Practitioner) Transfer Authorization Provider
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-transferAuthorizationProvider
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 1..1 DP_Identifier_A Business Identifier for a claim response
... status ?!Σ 1..1 DP_code active | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required)
Required Pattern: active
... type Σ 1..1 DP_CodeableConcept More granular claim type
Binding: Claim Type Codes (required)
... subType 1..1 DP_CodeableConcept More granular claim type
Binding: Claim SubType (required)
... use Σ 1..1 DP_code claim | preauthorization | predetermination
Binding: Use (required): Claim, preauthorization, predetermination.
... patient Σ 1..1 DP_Reference_1or2a(Nphies Patient) The recipient of the products and services
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣC 0..1 string Literal reference, Relative, internal or absolute URL
Max Length:250
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier SΣ 0..1 Identifier Logical reference, when literal reference is not known
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 1..1 DP_CodeableConcept Description of identifier
Binding: Patient Identifier Type (required)
..... system Σ 1..1 DP_uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
Max Length:50
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... display Σ 0..1 string Text alternative for the resource
Max Length:200
... created Σ 1..1 DP_dateTime Response creation date
... insurer Σ 1..1 DP_Reference_1or2a(Nphies Insurer Organization) Party responsible for reimbursement
... requestor 0..1 Reference(Practitioner | PractitionerRole | Organization) Party responsible for the claim
... request Σ 0..1 Reference(Claim) Id of resource triggering adjudication
... outcome Σ 1..1 DP_code queued | complete | error | partial
Binding: ClaimProcessingCodes (required): The result of the claim processing.
... disposition S 0..1 DP_string Disposition Message
... preAuthRef S 0..1 DP_string Preauthorization reference
... preAuthPeriod S 0..1 DP_Period_2 Preauthorization reference effective period
... payeeType S 0..1 DP_CodeableConcept Party to be paid any benefits payable
Binding: Claim Payee Type Codes (required)
... item 0..* BackboneElement Adjudication for claim line items
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... itemSequence 1..1 positiveInt Claim item instance identifier
.... noteNumber 0..* positiveInt Applicable note numbers
.... adjudication 1..* BackboneElement Adjudication details
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... category 1..1 CodeableConcept Type of adjudication information
Binding: AdjudicationValueCodes (example): The adjudication codes.
..... reason 0..1 CodeableConcept Explanation of adjudication outcome
Binding: AdjudicationReasonCodes (example): The adjudication reason codes.
..... amount 0..1 Money Monetary amount
..... value 0..1 decimal Non-monetary value
.... detail 0..* BackboneElement Adjudication for claim details
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... detailSequence 1..1 positiveInt Claim detail instance identifier
..... noteNumber 0..* positiveInt Applicable note numbers
..... adjudication 1..* See adjudication (ClaimResponse) Detail level adjudication details
..... subDetail 0..* BackboneElement Adjudication for claim sub-details
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... subDetailSequence 1..1 positiveInt Claim sub-detail instance identifier
...... noteNumber 0..* positiveInt Applicable note numbers
...... adjudication 0..* See adjudication (ClaimResponse) Subdetail level adjudication details
... addItem SC 0..* BackboneElement Insurer added line items
Constraints: BV-00614
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:adjudication-outcome 1..1 CodeableConcept Adjudication Outcome
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-adjudication-outcome
Binding: Adjudication Outcome (required)
..... extension:sequence 1..1 DP_positiveInt Sequence Extension
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-sequence
..... extension:diagnosesSequence S 0..* DP_positiveInt Diagnosis Sequence Extension
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-diagnosis-sequence
..... extension:informationSequence S 0..* DP_positiveInt Information Sequence Extension
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-informationSequence
..... extension:package S 0..1 boolean Package Code
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-package
..... extension:maternity 1..1 boolean Maternity
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-maternity
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... itemSequence 0..* positiveInt Item sequence number
.... detailSequence 0..* positiveInt Detail sequence number
.... subdetailSequence 0..* positiveInt Subdetail sequence number
.... provider 0..1 DP_Reference_1or2aor4(Nphies Practitioner) Authorized providers
.... productOrService 1..1 DP_CodeableConcept_2 Billing, service, product, or drug code
Binding: USCLSCodes (example): Allowable service and product codes.
.... modifier 0..* CodeableConcept Service/Product billing modifiers
Binding: ModifierTypeCodes (example): Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.
.... programCode 0..* CodeableConcept Program the product or service is provided under
Binding: ExampleProgramReasonCodes (example): Program specific reason codes.
.... serviced[x] 0..1 Date or dates of service or product delivery
..... servicedDate date
..... servicedPeriod Period
.... location[x] 0..1 Place of service or where product was supplied
Binding: ExampleServicePlaceCodes (example): Place of service: pharmacy, school, prison, etc.
..... locationCodeableConcept CodeableConcept
..... locationAddress Address
..... locationReference Reference(Location)
.... quantity S 0..1 DP_SimpleQuantity_1 Count of products or services
.... unitPrice 0..1 Money Fee, charge or cost per item
.... factor 0..1 decimal Price scaling factor
.... net 0..1 Money Total item cost
.... bodySite S 0..1 DP_CodeableConcept Anatomical location
Binding: OralSiteCodes (example): The code for the teeth, quadrant, sextant and arch.
.... subSite S 0..1 DP_CodeableConcept Anatomical sub-location
Binding: SurfaceCodes (example): The code for the tooth surface and surface combinations.
.... noteNumber S 0..* DP_positiveInt Applicable note numbers
.... adjudication 1..* BackboneElement Added items adjudication
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... category 1..1 DP_CodeableConcept Type of adjudication information
Binding: Adjudication (required)
..... reason S 0..1 DP_CodeableConcept Explanation of adjudication outcome
Binding: Adjudication Reason (required)
..... amount S 0..1 DP_Money_SAR Monetary amount
..... value S 0..1 DP_decimal Non-monetary value
.... detail S 0..* BackboneElement Insurer added line details
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:sequence 1..1 DP_positiveInt Sequence Extension
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-sequence
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... productOrService 1..1 DP_CodeableConcept_2 Billing, service, product, or drug code
Binding: USCLSCodes (example): Allowable service and product codes.
..... modifier 0..* CodeableConcept Service/Product billing modifiers
Binding: ModifierTypeCodes (example): Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.
..... quantity S 0..1 DP_SimpleQuantity_1 Count of products or services
..... unitPrice 0..1 Money Fee, charge or cost per item
..... factor 0..1 decimal Price scaling factor
..... net 0..1 Money Total item cost
..... noteNumber S 0..* DP_positiveInt Applicable note numbers
..... adjudication 1..* BackboneElement Added items detail adjudication
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... category 1..1 DP_CodeableConcept Type of adjudication information
Binding: Adjudication (required)
...... reason S 0..1 DP_CodeableConcept Explanation of adjudication outcome
Binding: Adjudication Reason (required)
...... amount S 0..1 DP_Money_SAR Monetary amount
...... value S 0..1 DP_decimal Non-monetary value
..... subDetail S 0..* BackboneElement Insurer added line items
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:sequence 1..1 DP_positiveInt Sequence Extension
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-sequence
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... productOrService 1..1 DP_CodeableConcept_2 Billing, service, product, or drug code
Binding: USCLSCodes (example): Allowable service and product codes.
...... modifier 0..* CodeableConcept Service/Product billing modifiers
Binding: ModifierTypeCodes (example): Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.
...... quantity S 0..1 DP_SimpleQuantity_1 Count of products or services
...... unitPrice 0..1 Money Fee, charge or cost per item
...... factor 0..1 decimal Price scaling factor
...... net 0..1 Money Total item cost
...... noteNumber S 0..* DP_positiveInt Applicable note numbers
...... adjudication 1..* BackboneElement Added items detail adjudication
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... category 1..1 DP_CodeableConcept Type of adjudication information
Binding: Adjudication (required)
....... reason S 0..1 DP_CodeableConcept Explanation of adjudication outcome
Binding: Adjudication Reason (required)
....... amount S 0..1 DP_Money_SAR Monetary amount
....... value S 0..1 DP_decimal Non-monetary value
... adjudication 0..* See adjudication (ClaimResponse) Header-level adjudication
... total SΣ 0..* BackboneElement Adjudication totals
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... category Σ 1..1 DP_CodeableConcept Type of adjudication information
Binding: Adjudication (required)
.... amount Σ 1..1 DP_Money_SAR Financial total for the category
... payment 0..1 BackboneElement Payment Details
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 1..1 CodeableConcept Partial or complete payment
Binding: ExamplePaymentTypeCodes (example): The type (partial, complete) of the payment.
.... adjustment 0..1 Money Payment adjustment for non-claim issues
.... adjustmentReason 0..1 CodeableConcept Explanation for the adjustment
Binding: PaymentAdjustmentReasonCodes (example): Payment Adjustment reason codes.
.... date 0..1 date Expected date of payment
.... amount 1..1 Money Payable amount after adjustment
.... identifier 0..1 Identifier Business identifier for the payment
... fundsReserve S 0..1 CodeableConcept Funds reserved status
Binding: Funds Reservation Codes (required)
... formCode 0..1 CodeableConcept Printed form identifier
Binding: Form Codes (example): The forms codes.
... form 0..1 Attachment Printed reference or actual form
... processNote S 0..* BackboneElement Note concerning adjudication
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... number 1..1 DP_positiveInt Note instance identifier
.... type 1..1 DP_code display | print | printoper
Binding: NoteType (required): The presentation types of notes.
.... text 1..1 DP_string Note explanatory text
.... language S 0..1 DP_CodeableConcept Language of the text
Binding: KSA Languages (required)
... communicationRequest 0..* Reference(CommunicationRequest) Request for additional information
... insurance 1..* BackboneElement Patient insurance information
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... sequence 1..1 DP_positiveInt Insurance instance identifier
.... focal 1..1 boolean Coverage to be used for adjudication
.... coverage 1..1 DP_Reference_1(Coverage) Insurance information
.... businessArrangement 0..1 string Additional provider contract number
.... claimResponse 0..1 Reference(ClaimResponse) Adjudication results
... error 0..* BackboneElement Processing errors
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... itemSequence 0..1 positiveInt Item sequence number
.... detailSequence 0..1 positiveInt Detail sequence number
.... subDetailSequence 0..1 positiveInt Subdetail sequence number
.... code 1..1 CodeableConcept Error code detailing processing issues
Binding: Adjudication Error Codes (example): The adjudication error codes.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ClaimResponse.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
From the FHIR Standard
ClaimResponse.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
From the FHIR Standard
ClaimResponse.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
ClaimResponse.statusrequiredPattern Value: active
http://hl7.org/fhir/ValueSet/fm-status
From the FHIR Standard
ClaimResponse.typerequiredClaimTypeCodes
http://nphies.sa/terminology/ValueSet/claim-type
From this IG
ClaimResponse.subTyperequiredClaimSubType(a valid code from Claim SubType)
http://nphies.sa/terminology/ValueSet/claim-subtype
From this IG
ClaimResponse.userequiredUse
http://hl7.org/fhir/ValueSet/claim-use|4.0.1
From the FHIR Standard
ClaimResponse.patient.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
ClaimResponse.patient.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
ClaimResponse.patient.identifier.typerequiredPatientIdentifierType
http://nphies.sa/terminology/ValueSet/patient-identifier-type
From this IG
ClaimResponse.outcomerequiredClaimProcessingCodes
http://hl7.org/fhir/ValueSet/remittance-outcome|4.0.1
From the FHIR Standard
ClaimResponse.payeeTyperequiredClaim Payee Type Codes
http://hl7.org/fhir/ValueSet/payeetype
From the FHIR Standard
ClaimResponse.item.adjudication.categoryexampleAdjudicationValueCodes
http://hl7.org/fhir/ValueSet/adjudication
From the FHIR Standard
ClaimResponse.item.adjudication.reasonexampleAdjudicationReasonCodes
http://hl7.org/fhir/ValueSet/adjudication-reason
From the FHIR Standard
ClaimResponse.addItem.productOrServiceexampleUSCLSCodes
http://hl7.org/fhir/ValueSet/service-uscls
From the FHIR Standard
ClaimResponse.addItem.modifierexampleModifierTypeCodes
http://hl7.org/fhir/ValueSet/claim-modifiers
From the FHIR Standard
ClaimResponse.addItem.programCodeexampleExampleProgramReasonCodes
http://hl7.org/fhir/ValueSet/ex-program-code
From the FHIR Standard
ClaimResponse.addItem.location[x]exampleExampleServicePlaceCodes
http://hl7.org/fhir/ValueSet/service-place
From the FHIR Standard
ClaimResponse.addItem.bodySiteexampleOralSiteCodes
http://hl7.org/fhir/ValueSet/tooth
From the FHIR Standard
ClaimResponse.addItem.subSiteexampleSurfaceCodes
http://hl7.org/fhir/ValueSet/surface
From the FHIR Standard
ClaimResponse.addItem.adjudication.categoryrequiredAdjudication
http://nphies.sa/terminology/ValueSet/adjudication
From this IG
ClaimResponse.addItem.adjudication.reasonrequiredAdjudicationReason(a valid code from Adjudication Reason)
http://nphies.sa/terminology/ValueSet/adjudication-reason
From this IG
ClaimResponse.addItem.detail.productOrServiceexampleUSCLSCodes
http://hl7.org/fhir/ValueSet/service-uscls
From the FHIR Standard
ClaimResponse.addItem.detail.modifierexampleModifierTypeCodes
http://hl7.org/fhir/ValueSet/claim-modifiers
From the FHIR Standard
ClaimResponse.addItem.detail.adjudication.categoryrequiredAdjudication
http://nphies.sa/terminology/ValueSet/adjudication
From this IG
ClaimResponse.addItem.detail.adjudication.reasonrequiredAdjudicationReason(a valid code from Adjudication Reason)
http://nphies.sa/terminology/ValueSet/adjudication-reason
From this IG
ClaimResponse.addItem.detail.subDetail.productOrServiceexampleUSCLSCodes
http://hl7.org/fhir/ValueSet/service-uscls
From the FHIR Standard
ClaimResponse.addItem.detail.subDetail.modifierexampleModifierTypeCodes
http://hl7.org/fhir/ValueSet/claim-modifiers
From the FHIR Standard
ClaimResponse.addItem.detail.subDetail.adjudication.categoryrequiredAdjudication
http://nphies.sa/terminology/ValueSet/adjudication
From this IG
ClaimResponse.addItem.detail.subDetail.adjudication.reasonrequiredAdjudicationReason(a valid code from Adjudication Reason)
http://nphies.sa/terminology/ValueSet/adjudication-reason
From this IG
ClaimResponse.total.categoryrequiredAdjudication
http://nphies.sa/terminology/ValueSet/adjudication
From this IG
ClaimResponse.payment.typeexampleExamplePaymentTypeCodes
http://hl7.org/fhir/ValueSet/ex-paymenttype
From the FHIR Standard
ClaimResponse.payment.adjustmentReasonexamplePaymentAdjustmentReasonCodes
http://hl7.org/fhir/ValueSet/payment-adjustment-reason
From the FHIR Standard
ClaimResponse.fundsReserverequiredFunds Reservation Codes
http://hl7.org/fhir/ValueSet/fundsreserve
From the FHIR Standard
ClaimResponse.formCodeexampleForm Codes
http://hl7.org/fhir/ValueSet/forms
From the FHIR Standard
ClaimResponse.processNote.typerequiredNoteType
http://hl7.org/fhir/ValueSet/note-type|4.0.1
From the FHIR Standard
ClaimResponse.processNote.languagerequiredKSALanguages
http://nphies.sa/terminology/ValueSet/ksa-languages
From this IG
ClaimResponse.error.codeexampleAdjudication Error Codes
http://hl7.org/fhir/ValueSet/adjudication-error
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
BV-00569errorClaimResponseAdvanced preAuthorization- ClaimResponse use can only use the fixed value 'preauthorization'.
: use.exists() and use = 'preauthorization'
BV-00570errorClaimResponseAdvanced preAuthorization - ClaimResponse outcome can only be 'complete'.
: outcome.exists() and outcome = 'complete'
BV-00607errorClaimResponseClaimResponse status is not 'active'.
: status.exists() implies status = 'active'
BV-00609errorClaimResponseClaimResponse status is not 'active'.
: type.exists() implies (type = 'oral') implies subType.coding.first().code = 'op'
BV-00610errorClaimResponseClaimResponse status is not 'active'.
: type.exists() implies (type = 'vision') implies subType.coding.first().code = 'op'
BV-00611errorClaimResponseClaimResponse status is not 'active'.
: type.exists() implies (type = 'pharmacy') implies subType.coding.first().code = 'op'
BV-00614errorClaimResponse.addItemAdvanced preauthorization - The subSite shall not be allowed if the bodySite is not provided.
: subSite.exists() implies bodySite.exists()
dom-2errorClaimResponseIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorClaimResponseIf 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-4errorClaimResponseIf 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-5errorClaimResponseIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceClaimResponseA 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 ClaimResponse

Summary

Mandatory: 9 elements(9 nested mandatory elements)
Must-Support: 40 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron