FHIR Implementation Guide for NJSAMS


1.0.0 - release

NJSAMS - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: NJSAMSClaim

Official URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/NJSAMSClaim Version: 1.0.0
Active as of 2025-06-23 Computable Name: NJSAMSClaim

NJSAMS Claim

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Claim 0..* Claim Claim, Pre-determination or Pre-authorization
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-6: A resource should have narrative for robust management
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:is-core-package S 0..1 boolean Extension
URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/IsCorePackage
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:package-name S 1..1 string Extension
URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/PackageName
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?!N 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... identifier:priorAuthNo S 0..1 Identifier NJSAMS Prior Authorization Number
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
..... system Σ 1..1 uri The namespace for the identifier value
ele-1: All FHIR elements must have a @value or children
Required Pattern: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/PAuthNo
.... identifier:authId S 0..1 Identifier NJSAMS Authorization ID
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
..... system Σ 1..1 uri The namespace for the identifier value
ele-1: All FHIR elements must have a @value or children
Required Pattern: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/AuthorizationID
... status ?!Σ 1..1 code active | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.


ele-1: All FHIR elements must have a @value or children
... type Σ 1..1 CodeableConcept Category or discipline
Binding: ClaimTypeCodes (extensible): The type or discipline-style of the claim.


ele-1: All FHIR elements must have a @value or children
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/claim-type
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: professional
... use Σ 1..1 code claim | preauthorization | predetermination
Binding: Use (required): The purpose of the Claim: predetermination, preauthorization, claim.


ele-1: All FHIR elements must have a @value or children
Required Pattern: preauthorization
... patient ΣC 1..1 Reference(Patient) The recipient of the products and services
ele-1: All FHIR elements must have a @value or children
ref-1: SHALL have a contained resource if a local reference is provided
... created Σ 1..1 dateTime Resource creation date
ele-1: All FHIR elements must have a @value or children
... provider ΣC 1..1 Reference(Practitioner | PractitionerRole | Organization) Party responsible for the claim
ele-1: All FHIR elements must have a @value or children
ref-1: SHALL have a contained resource if a local reference is provided
... priority Σ 1..1 CodeableConcept Desired processing ugency
Binding: ProcessPriorityCodes (example): The timeliness with which processing is required: stat, normal, deferred.


ele-1: All FHIR elements must have a @value or children
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/processpriority
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: normal
... supportingInfo S 1..* BackboneElement Supporting information
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... sequence 1..1 positiveInt Information instance identifier
ele-1: All FHIR elements must have a @value or children
.... category 1..1 CodeableConcept Classification of the supplied information
Binding: ClaimInformationCategoryCodes (example): The valuset used for additional information category codes.


ele-1: All FHIR elements must have a @value or children
.... Slices for timing[x] 0..1 When it occurred
Slice: Unordered, Open by type:$this
ele-1: All FHIR elements must have a @value or children
..... timingDate date
..... timingPeriod Period
..... timing[x]:timingPeriod 0..1 Period When it occurred
ele-1: All FHIR elements must have a @value or children
...... start ΣC 0..1 dateTime Starting time with inclusive boundary
ele-1: All FHIR elements must have a @value or children
...... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
ele-1: All FHIR elements must have a @value or children
... insurance Σ 1..* BackboneElement Patient insurance information
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... sequence Σ 1..1 positiveInt Insurance instance identifier
ele-1: All FHIR elements must have a @value or children
.... focal Σ 1..1 boolean Coverage to be used for adjudication
ele-1: All FHIR elements must have a @value or children
.... coverage ΣC 1..1 Reference(Coverage) Insurance information
ele-1: All FHIR elements must have a @value or children
ref-1: SHALL have a contained resource if a local reference is provided

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Claim.identifier:priorAuthNo.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Claim.identifier:authId.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Claim.statusrequiredFinancialResourceStatusCodes
http://hl7.org/fhir/ValueSet/fm-status|4.0.1
from the FHIR Standard
Claim.typeextensiblePattern: professional
http://hl7.org/fhir/ValueSet/claim-type
from the FHIR Standard
Claim.userequiredPattern: preauthorization
http://hl7.org/fhir/ValueSet/claim-use|4.0.1
from the FHIR Standard
Claim.priorityexamplePattern: normal
http://hl7.org/fhir/ValueSet/process-priority
from the FHIR Standard
Claim.supportingInfo.categoryexampleClaimInformationCategoryCodes
http://hl7.org/fhir/ValueSet/claim-informationcategory
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorClaimIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorClaimIf 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-4errorClaimIf 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-5errorClaimIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceClaimA 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** elementsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ref-1errorClaim.patient, Claim.provider, Claim.insurance.coverageSHALL have a contained resource if a local reference is provided
: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

This structure is derived from Claim

NameFlagsCard.TypeDescription & Constraintsdoco
.. Claim 0..* Claim Claim, Pre-determination or Pre-authorization
... extension 1..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:is-core-package S 0..1 boolean Extension
URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/IsCorePackage
.... extension:package-name S 1..1 string Extension
URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/PackageName
... Slices for identifier S 1..* Identifier Business Identifier for claim
Slice: Unordered, Open by value:system
.... identifier:priorAuthNo S 0..1 Identifier NJSAMS Prior Authorization Number
..... system 1..1 uri The namespace for the identifier value
Required Pattern: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/PAuthNo
.... identifier:authId S 0..1 Identifier NJSAMS Authorization ID
..... system 1..1 uri The namespace for the identifier value
Required Pattern: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/AuthorizationID
... type 1..1 CodeableConcept Category or discipline
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/claim-type
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: professional
... use 1..1 code claim | preauthorization | predetermination
Required Pattern: preauthorization
... patient 1..1 Reference(Patient) The recipient of the products and services
... created 1..1 dateTime Resource creation date
... provider 1..1 Reference(Practitioner | PractitionerRole | Organization) Party responsible for the claim
... priority 1..1 CodeableConcept Desired processing ugency
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/processpriority
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: normal
... supportingInfo S 1..* BackboneElement Supporting information
.... sequence 1..1 positiveInt Information instance identifier
.... category 1..1 CodeableConcept Classification of the supplied information
.... Slices for timing[x] 0..1 date, Period When it occurred
Slice: Unordered, Open by type:$this
..... timing[x]:timingPeriod 0..1 Period When it occurred
...... start 0..1 dateTime Starting time with inclusive boundary
...... end 0..1 dateTime End time with inclusive boundary, if not ongoing
... insurance
.... sequence 1..1 positiveInt Insurance instance identifier
.... focal 1..1 boolean Coverage to be used for adjudication
.... coverage 1..1 Reference(Coverage) Insurance information

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Claim 0..* Claim Claim, Pre-determination or Pre-authorization
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:is-core-package S 0..1 boolean Extension
URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/IsCorePackage
.... extension:package-name S 1..1 string Extension
URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/PackageName
... modifierExtension ?!N 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... Slices for identifier S 1..* Identifier Business Identifier for claim
Slice: Unordered, Open by value:system
.... identifier:priorAuthNo S 0..1 Identifier NJSAMS Prior Authorization Number
..... id 0..1 string Unique id for inter-element referencing
..... extension N 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 Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/PAuthNo
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... period ΣC 0..1 Period Time period when id is/was valid for use
per-1: If present, start SHALL have a lower value than end
..... assigner ΣC 0..1 Reference(Organization) Organization that issued id (may be just text)
ref-1: SHALL have a contained resource if a local reference is provided
.... identifier:authId S 0..1 Identifier NJSAMS Authorization ID
..... id 0..1 string Unique id for inter-element referencing
..... extension N 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 Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/AuthorizationID
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... period ΣC 0..1 Period Time period when id is/was valid for use
per-1: If present, start SHALL have a lower value than end
..... assigner ΣC 0..1 Reference(Organization) Organization that issued id (may be just text)
ref-1: SHALL have a contained resource if a local reference is provided
... status ?!Σ 1..1 code active | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.

... type Σ 1..1 CodeableConcept Category or discipline
Binding: ClaimTypeCodes (extensible): The type or discipline-style of the claim.


Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/claim-type
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: professional
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... subType 0..1 CodeableConcept More granular claim type
Binding: ExampleClaimSubTypeCodes (example): A more granular claim typecode.

... use Σ 1..1 code claim | preauthorization | predetermination
Binding: Use (required): The purpose of the Claim: predetermination, preauthorization, claim.


Required Pattern: preauthorization
... patient ΣC 1..1 Reference(Patient) The recipient of the products and services
ref-1: SHALL have a contained resource if a local reference is provided
... billablePeriod ΣC 0..1 Period Relevant time frame for the claim
per-1: If present, start SHALL have a lower value than end
... created Σ 1..1 dateTime Resource creation date
... enterer C 0..1 Reference(Practitioner | PractitionerRole) Author of the claim
ref-1: SHALL have a contained resource if a local reference is provided
... insurer ΣC 0..1 Reference(Organization) Target
ref-1: SHALL have a contained resource if a local reference is provided
... provider ΣC 1..1 Reference(Practitioner | PractitionerRole | Organization) Party responsible for the claim
ref-1: SHALL have a contained resource if a local reference is provided
... priority Σ 1..1 CodeableConcept Desired processing ugency
Binding: ProcessPriorityCodes (example): The timeliness with which processing is required: stat, normal, deferred.


Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/processpriority
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: normal
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... fundsReserve 0..1 CodeableConcept For whom to reserve funds
Binding: Funds Reservation Codes (example): For whom funds are to be reserved: (Patient, Provider, None).

... related 0..* BackboneElement Prior or corollary claims
.... id 0..1 string Unique id for inter-element referencing
.... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... claim C 0..1 Reference(Claim) Reference to the related claim
ref-1: SHALL have a contained resource if a local reference is provided
.... relationship 0..1 CodeableConcept How the reference claim is related
Binding: ExampleRelatedClaimRelationshipCodes (example): Relationship of this claim to a related Claim.

.... reference 0..1 Identifier File or case reference
... prescription C 0..1 Reference(DeviceRequest | MedicationRequest | VisionPrescription) Prescription authorizing services and products
ref-1: SHALL have a contained resource if a local reference is provided
... originalPrescription C 0..1 Reference(DeviceRequest | MedicationRequest | VisionPrescription) Original prescription if superseded by fulfiller
ref-1: SHALL have a contained resource if a local reference is provided
... payee 0..1 BackboneElement Recipient of benefits payable
.... id 0..1 string Unique id for inter-element referencing
.... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 1..1 CodeableConcept Category of recipient
Binding: Claim Payee Type Codes (example): A code for the party to be reimbursed.

.... party C 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson) Recipient reference
ref-1: SHALL have a contained resource if a local reference is provided
... referral C 0..1 Reference(ServiceRequest) Treatment referral
ref-1: SHALL have a contained resource if a local reference is provided
... facility C 0..1 Reference(Location) Servicing facility
ref-1: SHALL have a contained resource if a local reference is provided
... careTeam 0..* BackboneElement Members of the care team
.... id 0..1 string Unique id for inter-element referencing
.... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... sequence 1..1 positiveInt Order of care team
.... provider C 1..1 Reference(Practitioner | PractitionerRole | Organization) Practitioner or organization
ref-1: SHALL have a contained resource if a local reference is provided
.... responsible 0..1 boolean Indicator of the lead practitioner
.... role 0..1 CodeableConcept Function within the team
Binding: ClaimCareTeamRoleCodes (example): The role codes for the care team members.

.... qualification 0..1 CodeableConcept Practitioner credential or specialization
Binding: ExampleProviderQualificationCodes (example): Provider professional qualifications.

... supportingInfo S 1..* BackboneElement Supporting information
.... id 0..1 string Unique id for inter-element referencing
.... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... sequence 1..1 positiveInt Information instance identifier
.... category 1..1 CodeableConcept Classification of the supplied information
Binding: ClaimInformationCategoryCodes (example): The valuset used for additional information category codes.

.... code 0..1 CodeableConcept Type of information
Binding: ExceptionCodes (example): The valuset used for additional information codes.

.... Slices for timing[x] 0..1 When it occurred
Slice: Unordered, Open by type:$this
..... timingDate date
..... timingPeriod Period
..... timing[x]:timingPeriod 0..1 Period When it occurred
...... id 0..1 string Unique id for inter-element referencing
...... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... start ΣC 0..1 dateTime Starting time with inclusive boundary
...... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
.... value[x] 0..1 Data to be provided
..... valueBoolean boolean
..... valueString string
..... valueQuantity Quantity
..... valueAttachment Attachment
..... valueReference Reference(Resource)
.... reason 0..1 CodeableConcept Explanation for the information
Binding: MissingToothReasonCodes (example): Reason codes for the missing teeth.

... diagnosis 0..* BackboneElement Pertinent diagnosis information
.... id 0..1 string Unique id for inter-element referencing
.... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... sequence 1..1 positiveInt Diagnosis instance identifier
.... diagnosis[x] 1..1 Nature of illness or problem
Binding: ICD-10Codes (example): Example ICD10 Diagnostic codes.

..... diagnosisCodeableConcept CodeableConcept
..... diagnosisReference Reference(Condition)
.... type 0..* CodeableConcept Timing or nature of the diagnosis
Binding: ExampleDiagnosisTypeCodes (example): The type of the diagnosis: admitting, principal, discharge.


.... onAdmission 0..1 CodeableConcept Present on admission
Binding: ExampleDiagnosisOnAdmissionCodes (example): Present on admission.

.... packageCode 0..1 CodeableConcept Package billing code
Binding: ExampleDiagnosisRelatedGroupCodes (example): The DRG codes associated with the diagnosis.

... procedure 0..* BackboneElement Clinical procedures performed
.... id 0..1 string Unique id for inter-element referencing
.... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... sequence 1..1 positiveInt Procedure instance identifier
.... type 0..* CodeableConcept Category of Procedure
Binding: ExampleProcedureTypeCodes (example): Example procedure type codes.


.... date 0..1 dateTime When the procedure was performed
.... procedure[x] 1..1 Specific clinical procedure
Binding: ICD-10ProcedureCodes (example): Example ICD10 Procedure codes.

..... procedureCodeableConcept CodeableConcept
..... procedureReference Reference(Procedure)
.... udi C 0..* Reference(Device) Unique device identifier
ref-1: SHALL have a contained resource if a local reference is provided
... insurance Σ 1..* BackboneElement Patient insurance information
.... id 0..1 string Unique id for inter-element referencing
.... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... sequence Σ 1..1 positiveInt Insurance instance identifier
.... focal Σ 1..1 boolean Coverage to be used for adjudication
.... identifier 0..1 Identifier Pre-assigned Claim number
.... coverage ΣC 1..1 Reference(Coverage) Insurance information
ref-1: SHALL have a contained resource if a local reference is provided
.... businessArrangement 0..1 string Additional provider contract number
.... preAuthRef 0..* string Prior authorization reference number
.... claimResponse C 0..1 Reference(ClaimResponse) Adjudication results
ref-1: SHALL have a contained resource if a local reference is provided
... accident 0..1 BackboneElement Details of the event
.... id 0..1 string Unique id for inter-element referencing
.... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... date 1..1 date When the incident occurred
.... type 0..1 CodeableConcept The nature of the accident
Binding: ActIncidentCode (extensible): Type of accident: work place, auto, etc.

.... location[x] 0..1 Where the event occurred
..... locationAddress Address
..... locationReference Reference(Location)
... item 0..* BackboneElement Product or service provided
.... id 0..1 string Unique id for inter-element referencing
.... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... sequence 1..1 positiveInt Item instance identifier
.... careTeamSequence 0..* positiveInt Applicable careTeam members
.... diagnosisSequence 0..* positiveInt Applicable diagnoses
.... procedureSequence 0..* positiveInt Applicable procedures
.... informationSequence 0..* positiveInt Applicable exception and supporting information
.... revenue 0..1 CodeableConcept Revenue or cost center code
Binding: ExampleRevenueCenterCodes (example): Codes for the revenue or cost centers supplying the service and/or products.

.... category 0..1 CodeableConcept Benefit classification
Binding: BenefitCategoryCodes (example): Benefit categories such as: oral-basic, major, glasses.

.... productOrService 1..1 CodeableConcept Billing, service, product, or drug code
Binding: USCLSCodes (example): Allowable service and product codes.

.... modifier 0..* CodeableConcept Product or service 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 C 0..1 SimpleQuantity Count of products or services
qty-3: If a code for the unit is present, the system SHALL also be present
sqty-1: The comparator is not used on a SimpleQuantity
.... unitPrice 0..1 Money Fee, charge or cost per item
.... factor 0..1 decimal Price scaling factor
.... net 0..1 Money Total item cost
.... udi C 0..* Reference(Device) Unique device identifier
ref-1: SHALL have a contained resource if a local reference is provided
.... bodySite 0..1 CodeableConcept Anatomical location
Binding: OralSiteCodes (example): The code for the teeth, quadrant, sextant and arch.

.... subSite 0..* CodeableConcept Anatomical sub-location
Binding: SurfaceCodes (example): The code for the tooth surface and surface combinations.


.... encounter C 0..* Reference(Encounter) Encounters related to this billed item
ref-1: SHALL have a contained resource if a local reference is provided
.... detail 0..* BackboneElement Product or service provided
..... id 0..1 string Unique id for inter-element referencing
..... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... sequence 1..1 positiveInt Item instance identifier
..... revenue 0..1 CodeableConcept Revenue or cost center code
Binding: ExampleRevenueCenterCodes (example): Codes for the revenue or cost centers supplying the service and/or products.

..... category 0..1 CodeableConcept Benefit classification
Binding: BenefitCategoryCodes (example): Benefit categories such as: oral-basic, major, glasses.

..... productOrService 1..1 CodeableConcept 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.


..... quantity C 0..1 SimpleQuantity Count of products or services
qty-3: If a code for the unit is present, the system SHALL also be present
sqty-1: The comparator is not used on a SimpleQuantity
..... unitPrice 0..1 Money Fee, charge or cost per item
..... factor 0..1 decimal Price scaling factor
..... net 0..1 Money Total item cost
..... udi C 0..* Reference(Device) Unique device identifier
ref-1: SHALL have a contained resource if a local reference is provided
..... subDetail 0..* BackboneElement Product or service provided
...... id 0..1 string Unique id for inter-element referencing
...... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... sequence 1..1 positiveInt Item instance identifier
...... revenue 0..1 CodeableConcept Revenue or cost center code
Binding: ExampleRevenueCenterCodes (example): Codes for the revenue or cost centers supplying the service and/or products.

...... category 0..1 CodeableConcept Benefit classification
Binding: BenefitCategoryCodes (example): Benefit categories such as: oral-basic, major, glasses.

...... productOrService 1..1 CodeableConcept 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.


...... quantity C 0..1 SimpleQuantity Count of products or services
qty-3: If a code for the unit is present, the system SHALL also be present
sqty-1: The comparator is not used on a SimpleQuantity
...... unitPrice 0..1 Money Fee, charge or cost per item
...... factor 0..1 decimal Price scaling factor
...... net 0..1 Money Total item cost
...... udi C 0..* Reference(Device) Unique device identifier
ref-1: SHALL have a contained resource if a local reference is provided
... total 0..1 Money Total claim cost

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Claim.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Claim.identifier:priorAuthNo.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Claim.identifier:priorAuthNo.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Claim.identifier:authId.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Claim.identifier:authId.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Claim.statusrequiredFinancialResourceStatusCodes
http://hl7.org/fhir/ValueSet/fm-status|4.0.1
from the FHIR Standard
Claim.typeextensiblePattern: professional
http://hl7.org/fhir/ValueSet/claim-type
from the FHIR Standard
Claim.subTypeexampleExampleClaimSubTypeCodes
http://hl7.org/fhir/ValueSet/claim-subtype
from the FHIR Standard
Claim.userequiredPattern: preauthorization
http://hl7.org/fhir/ValueSet/claim-use|4.0.1
from the FHIR Standard
Claim.priorityexamplePattern: normal
http://hl7.org/fhir/ValueSet/process-priority
from the FHIR Standard
Claim.fundsReserveexampleFunds Reservation Codes
http://hl7.org/fhir/ValueSet/fundsreserve
from the FHIR Standard
Claim.related.relationshipexampleExampleRelatedClaimRelationshipCodes
http://hl7.org/fhir/ValueSet/related-claim-relationship
from the FHIR Standard
Claim.payee.typeexampleClaim Payee Type Codes
http://hl7.org/fhir/ValueSet/payeetype
from the FHIR Standard
Claim.careTeam.roleexampleClaimCareTeamRoleCodes
http://hl7.org/fhir/ValueSet/claim-careteamrole
from the FHIR Standard
Claim.careTeam.qualificationexampleExampleProviderQualificationCodes
http://hl7.org/fhir/ValueSet/provider-qualification
from the FHIR Standard
Claim.supportingInfo.categoryexampleClaimInformationCategoryCodes
http://hl7.org/fhir/ValueSet/claim-informationcategory
from the FHIR Standard
Claim.supportingInfo.codeexampleExceptionCodes
http://hl7.org/fhir/ValueSet/claim-exception
from the FHIR Standard
Claim.supportingInfo.reasonexampleMissingToothReasonCodes
http://hl7.org/fhir/ValueSet/missing-tooth-reason
from the FHIR Standard
Claim.diagnosis.diagnosis[x]exampleICD-10Codes
http://hl7.org/fhir/ValueSet/icd-10
from the FHIR Standard
Claim.diagnosis.typeexampleExampleDiagnosisTypeCodes
http://hl7.org/fhir/ValueSet/ex-diagnosistype
from the FHIR Standard
Claim.diagnosis.onAdmissionexampleExampleDiagnosisOnAdmissionCodes
http://hl7.org/fhir/ValueSet/ex-diagnosis-on-admission
from the FHIR Standard
Claim.diagnosis.packageCodeexampleExampleDiagnosisRelatedGroupCodes
http://hl7.org/fhir/ValueSet/ex-diagnosisrelatedgroup
from the FHIR Standard
Claim.procedure.typeexampleExampleProcedureTypeCodes
http://hl7.org/fhir/ValueSet/ex-procedure-type
from the FHIR Standard
Claim.procedure.procedure[x]exampleICD-10ProcedureCodes
http://hl7.org/fhir/ValueSet/icd-10-procedures
from the FHIR Standard
Claim.accident.typeextensibleActIncidentCode
http://terminology.hl7.org/ValueSet/v3-ActIncidentCode
Claim.item.revenueexampleExampleRevenueCenterCodes
http://hl7.org/fhir/ValueSet/ex-revenue-center
from the FHIR Standard
Claim.item.categoryexampleBenefitCategoryCodes
http://hl7.org/fhir/ValueSet/ex-benefitcategory
from the FHIR Standard
Claim.item.productOrServiceexampleUSCLSCodes
http://hl7.org/fhir/ValueSet/service-uscls
from the FHIR Standard
Claim.item.modifierexampleModifierTypeCodes
http://hl7.org/fhir/ValueSet/claim-modifiers
from the FHIR Standard
Claim.item.programCodeexampleExampleProgramReasonCodes
http://hl7.org/fhir/ValueSet/ex-program-code
from the FHIR Standard
Claim.item.location[x]exampleExampleServicePlaceCodes
http://hl7.org/fhir/ValueSet/service-place
from the FHIR Standard
Claim.item.bodySiteexampleOralSiteCodes
http://hl7.org/fhir/ValueSet/tooth
from the FHIR Standard
Claim.item.subSiteexampleSurfaceCodes
http://hl7.org/fhir/ValueSet/surface
from the FHIR Standard
Claim.item.detail.revenueexampleExampleRevenueCenterCodes
http://hl7.org/fhir/ValueSet/ex-revenue-center
from the FHIR Standard
Claim.item.detail.categoryexampleBenefitCategoryCodes
http://hl7.org/fhir/ValueSet/ex-benefitcategory
from the FHIR Standard
Claim.item.detail.productOrServiceexampleUSCLSCodes
http://hl7.org/fhir/ValueSet/service-uscls
from the FHIR Standard
Claim.item.detail.modifierexampleModifierTypeCodes
http://hl7.org/fhir/ValueSet/claim-modifiers
from the FHIR Standard
Claim.item.detail.programCodeexampleExampleProgramReasonCodes
http://hl7.org/fhir/ValueSet/ex-program-code
from the FHIR Standard
Claim.item.detail.subDetail.revenueexampleExampleRevenueCenterCodes
http://hl7.org/fhir/ValueSet/ex-revenue-center
from the FHIR Standard
Claim.item.detail.subDetail.categoryexampleBenefitCategoryCodes
http://hl7.org/fhir/ValueSet/ex-benefitcategory
from the FHIR Standard
Claim.item.detail.subDetail.productOrServiceexampleUSCLSCodes
http://hl7.org/fhir/ValueSet/service-uscls
from the FHIR Standard
Claim.item.detail.subDetail.modifierexampleModifierTypeCodes
http://hl7.org/fhir/ValueSet/claim-modifiers
from the FHIR Standard
Claim.item.detail.subDetail.programCodeexampleExampleProgramReasonCodes
http://hl7.org/fhir/ValueSet/ex-program-code
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorClaimIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorClaimIf 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-4errorClaimIf 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-5errorClaimIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceClaimA 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** elementsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
per-1errorClaim.identifier:priorAuthNo.period, Claim.identifier:authId.period, Claim.billablePeriodIf present, start SHALL have a lower value than end
: start.hasValue().not() or end.hasValue().not() or (start <= end)
qty-3errorClaim.item.quantity, Claim.item.detail.quantity, Claim.item.detail.subDetail.quantityIf a code for the unit is present, the system SHALL also be present
: code.empty() or system.exists()
ref-1errorClaim.identifier:priorAuthNo.assigner, Claim.identifier:authId.assigner, Claim.patient, Claim.enterer, Claim.insurer, Claim.provider, Claim.related.claim, Claim.prescription, Claim.originalPrescription, Claim.payee.party, Claim.referral, Claim.facility, Claim.careTeam.provider, Claim.procedure.udi, Claim.insurance.coverage, Claim.insurance.claimResponse, Claim.item.udi, Claim.item.encounter, Claim.item.detail.udi, Claim.item.detail.subDetail.udiSHALL have a contained resource if a local reference is provided
: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
sqty-1errorClaim.item.quantity, Claim.item.detail.quantity, Claim.item.detail.subDetail.quantityThe comparator is not used on a SimpleQuantity
: comparator.empty()

This structure is derived from Claim

Summary

Mandatory: 4 elements(2 nested mandatory elements)
Must-Support: 6 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Claim.identifier
  • The element 1 is sliced based on the value of Claim.supportingInfo.timing[x]

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Claim 0..* Claim Claim, Pre-determination or Pre-authorization
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-6: A resource should have narrative for robust management
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:is-core-package S 0..1 boolean Extension
URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/IsCorePackage
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:package-name S 1..1 string Extension
URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/PackageName
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?!N 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... identifier:priorAuthNo S 0..1 Identifier NJSAMS Prior Authorization Number
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
..... system Σ 1..1 uri The namespace for the identifier value
ele-1: All FHIR elements must have a @value or children
Required Pattern: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/PAuthNo
.... identifier:authId S 0..1 Identifier NJSAMS Authorization ID
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
..... system Σ 1..1 uri The namespace for the identifier value
ele-1: All FHIR elements must have a @value or children
Required Pattern: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/AuthorizationID
... status ?!Σ 1..1 code active | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.


ele-1: All FHIR elements must have a @value or children
... type Σ 1..1 CodeableConcept Category or discipline
Binding: ClaimTypeCodes (extensible): The type or discipline-style of the claim.


ele-1: All FHIR elements must have a @value or children
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/claim-type
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: professional
... use Σ 1..1 code claim | preauthorization | predetermination
Binding: Use (required): The purpose of the Claim: predetermination, preauthorization, claim.


ele-1: All FHIR elements must have a @value or children
Required Pattern: preauthorization
... patient ΣC 1..1 Reference(Patient) The recipient of the products and services
ele-1: All FHIR elements must have a @value or children
ref-1: SHALL have a contained resource if a local reference is provided
... created Σ 1..1 dateTime Resource creation date
ele-1: All FHIR elements must have a @value or children
... provider ΣC 1..1 Reference(Practitioner | PractitionerRole | Organization) Party responsible for the claim
ele-1: All FHIR elements must have a @value or children
ref-1: SHALL have a contained resource if a local reference is provided
... priority Σ 1..1 CodeableConcept Desired processing ugency
Binding: ProcessPriorityCodes (example): The timeliness with which processing is required: stat, normal, deferred.


ele-1: All FHIR elements must have a @value or children
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/processpriority
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: normal
... supportingInfo S 1..* BackboneElement Supporting information
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... sequence 1..1 positiveInt Information instance identifier
ele-1: All FHIR elements must have a @value or children
.... category 1..1 CodeableConcept Classification of the supplied information
Binding: ClaimInformationCategoryCodes (example): The valuset used for additional information category codes.


ele-1: All FHIR elements must have a @value or children
.... Slices for timing[x] 0..1 When it occurred
Slice: Unordered, Open by type:$this
ele-1: All FHIR elements must have a @value or children
..... timingDate date
..... timingPeriod Period
..... timing[x]:timingPeriod 0..1 Period When it occurred
ele-1: All FHIR elements must have a @value or children
...... start ΣC 0..1 dateTime Starting time with inclusive boundary
ele-1: All FHIR elements must have a @value or children
...... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
ele-1: All FHIR elements must have a @value or children
... insurance Σ 1..* BackboneElement Patient insurance information
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... sequence Σ 1..1 positiveInt Insurance instance identifier
ele-1: All FHIR elements must have a @value or children
.... focal Σ 1..1 boolean Coverage to be used for adjudication
ele-1: All FHIR elements must have a @value or children
.... coverage ΣC 1..1 Reference(Coverage) Insurance information
ele-1: All FHIR elements must have a @value or children
ref-1: SHALL have a contained resource if a local reference is provided

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Claim.identifier:priorAuthNo.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Claim.identifier:authId.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Claim.statusrequiredFinancialResourceStatusCodes
http://hl7.org/fhir/ValueSet/fm-status|4.0.1
from the FHIR Standard
Claim.typeextensiblePattern: professional
http://hl7.org/fhir/ValueSet/claim-type
from the FHIR Standard
Claim.userequiredPattern: preauthorization
http://hl7.org/fhir/ValueSet/claim-use|4.0.1
from the FHIR Standard
Claim.priorityexamplePattern: normal
http://hl7.org/fhir/ValueSet/process-priority
from the FHIR Standard
Claim.supportingInfo.categoryexampleClaimInformationCategoryCodes
http://hl7.org/fhir/ValueSet/claim-informationcategory
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorClaimIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorClaimIf 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-4errorClaimIf 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-5errorClaimIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceClaimA 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** elementsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ref-1errorClaim.patient, Claim.provider, Claim.insurance.coverageSHALL have a contained resource if a local reference is provided
: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Differential View

This structure is derived from Claim

NameFlagsCard.TypeDescription & Constraintsdoco
.. Claim 0..* Claim Claim, Pre-determination or Pre-authorization
... extension 1..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:is-core-package S 0..1 boolean Extension
URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/IsCorePackage
.... extension:package-name S 1..1 string Extension
URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/PackageName
... Slices for identifier S 1..* Identifier Business Identifier for claim
Slice: Unordered, Open by value:system
.... identifier:priorAuthNo S 0..1 Identifier NJSAMS Prior Authorization Number
..... system 1..1 uri The namespace for the identifier value
Required Pattern: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/PAuthNo
.... identifier:authId S 0..1 Identifier NJSAMS Authorization ID
..... system 1..1 uri The namespace for the identifier value
Required Pattern: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/AuthorizationID
... type 1..1 CodeableConcept Category or discipline
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/claim-type
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: professional
... use 1..1 code claim | preauthorization | predetermination
Required Pattern: preauthorization
... patient 1..1 Reference(Patient) The recipient of the products and services
... created 1..1 dateTime Resource creation date
... provider 1..1 Reference(Practitioner | PractitionerRole | Organization) Party responsible for the claim
... priority 1..1 CodeableConcept Desired processing ugency
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/processpriority
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: normal
... supportingInfo S 1..* BackboneElement Supporting information
.... sequence 1..1 positiveInt Information instance identifier
.... category 1..1 CodeableConcept Classification of the supplied information
.... Slices for timing[x] 0..1 date, Period When it occurred
Slice: Unordered, Open by type:$this
..... timing[x]:timingPeriod 0..1 Period When it occurred
...... start 0..1 dateTime Starting time with inclusive boundary
...... end 0..1 dateTime End time with inclusive boundary, if not ongoing
... insurance
.... sequence 1..1 positiveInt Insurance instance identifier
.... focal 1..1 boolean Coverage to be used for adjudication
.... coverage 1..1 Reference(Coverage) Insurance information

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Claim 0..* Claim Claim, Pre-determination or Pre-authorization
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:is-core-package S 0..1 boolean Extension
URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/IsCorePackage
.... extension:package-name S 1..1 string Extension
URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/PackageName
... modifierExtension ?!N 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... Slices for identifier S 1..* Identifier Business Identifier for claim
Slice: Unordered, Open by value:system
.... identifier:priorAuthNo S 0..1 Identifier NJSAMS Prior Authorization Number
..... id 0..1 string Unique id for inter-element referencing
..... extension N 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 Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/PAuthNo
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... period ΣC 0..1 Period Time period when id is/was valid for use
per-1: If present, start SHALL have a lower value than end
..... assigner ΣC 0..1 Reference(Organization) Organization that issued id (may be just text)
ref-1: SHALL have a contained resource if a local reference is provided
.... identifier:authId S 0..1 Identifier NJSAMS Authorization ID
..... id 0..1 string Unique id for inter-element referencing
..... extension N 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 Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/AuthorizationID
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... period ΣC 0..1 Period Time period when id is/was valid for use
per-1: If present, start SHALL have a lower value than end
..... assigner ΣC 0..1 Reference(Organization) Organization that issued id (may be just text)
ref-1: SHALL have a contained resource if a local reference is provided
... status ?!Σ 1..1 code active | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.

... type Σ 1..1 CodeableConcept Category or discipline
Binding: ClaimTypeCodes (extensible): The type or discipline-style of the claim.


Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/claim-type
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: professional
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... subType 0..1 CodeableConcept More granular claim type
Binding: ExampleClaimSubTypeCodes (example): A more granular claim typecode.

... use Σ 1..1 code claim | preauthorization | predetermination
Binding: Use (required): The purpose of the Claim: predetermination, preauthorization, claim.


Required Pattern: preauthorization
... patient ΣC 1..1 Reference(Patient) The recipient of the products and services
ref-1: SHALL have a contained resource if a local reference is provided
... billablePeriod ΣC 0..1 Period Relevant time frame for the claim
per-1: If present, start SHALL have a lower value than end
... created Σ 1..1 dateTime Resource creation date
... enterer C 0..1 Reference(Practitioner | PractitionerRole) Author of the claim
ref-1: SHALL have a contained resource if a local reference is provided
... insurer ΣC 0..1 Reference(Organization) Target
ref-1: SHALL have a contained resource if a local reference is provided
... provider ΣC 1..1 Reference(Practitioner | PractitionerRole | Organization) Party responsible for the claim
ref-1: SHALL have a contained resource if a local reference is provided
... priority Σ 1..1 CodeableConcept Desired processing ugency
Binding: ProcessPriorityCodes (example): The timeliness with which processing is required: stat, normal, deferred.


Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/processpriority
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: normal
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... fundsReserve 0..1 CodeableConcept For whom to reserve funds
Binding: Funds Reservation Codes (example): For whom funds are to be reserved: (Patient, Provider, None).

... related 0..* BackboneElement Prior or corollary claims
.... id 0..1 string Unique id for inter-element referencing
.... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... claim C 0..1 Reference(Claim) Reference to the related claim
ref-1: SHALL have a contained resource if a local reference is provided
.... relationship 0..1 CodeableConcept How the reference claim is related
Binding: ExampleRelatedClaimRelationshipCodes (example): Relationship of this claim to a related Claim.

.... reference 0..1 Identifier File or case reference
... prescription C 0..1 Reference(DeviceRequest | MedicationRequest | VisionPrescription) Prescription authorizing services and products
ref-1: SHALL have a contained resource if a local reference is provided
... originalPrescription C 0..1 Reference(DeviceRequest | MedicationRequest | VisionPrescription) Original prescription if superseded by fulfiller
ref-1: SHALL have a contained resource if a local reference is provided
... payee 0..1 BackboneElement Recipient of benefits payable
.... id 0..1 string Unique id for inter-element referencing
.... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 1..1 CodeableConcept Category of recipient
Binding: Claim Payee Type Codes (example): A code for the party to be reimbursed.

.... party C 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson) Recipient reference
ref-1: SHALL have a contained resource if a local reference is provided
... referral C 0..1 Reference(ServiceRequest) Treatment referral
ref-1: SHALL have a contained resource if a local reference is provided
... facility C 0..1 Reference(Location) Servicing facility
ref-1: SHALL have a contained resource if a local reference is provided
... careTeam 0..* BackboneElement Members of the care team
.... id 0..1 string Unique id for inter-element referencing
.... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... sequence 1..1 positiveInt Order of care team
.... provider C 1..1 Reference(Practitioner | PractitionerRole | Organization) Practitioner or organization
ref-1: SHALL have a contained resource if a local reference is provided
.... responsible 0..1 boolean Indicator of the lead practitioner
.... role 0..1 CodeableConcept Function within the team
Binding: ClaimCareTeamRoleCodes (example): The role codes for the care team members.

.... qualification 0..1 CodeableConcept Practitioner credential or specialization
Binding: ExampleProviderQualificationCodes (example): Provider professional qualifications.

... supportingInfo S 1..* BackboneElement Supporting information
.... id 0..1 string Unique id for inter-element referencing
.... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... sequence 1..1 positiveInt Information instance identifier
.... category 1..1 CodeableConcept Classification of the supplied information
Binding: ClaimInformationCategoryCodes (example): The valuset used for additional information category codes.

.... code 0..1 CodeableConcept Type of information
Binding: ExceptionCodes (example): The valuset used for additional information codes.

.... Slices for timing[x] 0..1 When it occurred
Slice: Unordered, Open by type:$this
..... timingDate date
..... timingPeriod Period
..... timing[x]:timingPeriod 0..1 Period When it occurred
...... id 0..1 string Unique id for inter-element referencing
...... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... start ΣC 0..1 dateTime Starting time with inclusive boundary
...... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
.... value[x] 0..1 Data to be provided
..... valueBoolean boolean
..... valueString string
..... valueQuantity Quantity
..... valueAttachment Attachment
..... valueReference Reference(Resource)
.... reason 0..1 CodeableConcept Explanation for the information
Binding: MissingToothReasonCodes (example): Reason codes for the missing teeth.

... diagnosis 0..* BackboneElement Pertinent diagnosis information
.... id 0..1 string Unique id for inter-element referencing
.... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... sequence 1..1 positiveInt Diagnosis instance identifier
.... diagnosis[x] 1..1 Nature of illness or problem
Binding: ICD-10Codes (example): Example ICD10 Diagnostic codes.

..... diagnosisCodeableConcept CodeableConcept
..... diagnosisReference Reference(Condition)
.... type 0..* CodeableConcept Timing or nature of the diagnosis
Binding: ExampleDiagnosisTypeCodes (example): The type of the diagnosis: admitting, principal, discharge.


.... onAdmission 0..1 CodeableConcept Present on admission
Binding: ExampleDiagnosisOnAdmissionCodes (example): Present on admission.

.... packageCode 0..1 CodeableConcept Package billing code
Binding: ExampleDiagnosisRelatedGroupCodes (example): The DRG codes associated with the diagnosis.

... procedure 0..* BackboneElement Clinical procedures performed
.... id 0..1 string Unique id for inter-element referencing
.... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... sequence 1..1 positiveInt Procedure instance identifier
.... type 0..* CodeableConcept Category of Procedure
Binding: ExampleProcedureTypeCodes (example): Example procedure type codes.


.... date 0..1 dateTime When the procedure was performed
.... procedure[x] 1..1 Specific clinical procedure
Binding: ICD-10ProcedureCodes (example): Example ICD10 Procedure codes.

..... procedureCodeableConcept CodeableConcept
..... procedureReference Reference(Procedure)
.... udi C 0..* Reference(Device) Unique device identifier
ref-1: SHALL have a contained resource if a local reference is provided
... insurance Σ 1..* BackboneElement Patient insurance information
.... id 0..1 string Unique id for inter-element referencing
.... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... sequence Σ 1..1 positiveInt Insurance instance identifier
.... focal Σ 1..1 boolean Coverage to be used for adjudication
.... identifier 0..1 Identifier Pre-assigned Claim number
.... coverage ΣC 1..1 Reference(Coverage) Insurance information
ref-1: SHALL have a contained resource if a local reference is provided
.... businessArrangement 0..1 string Additional provider contract number
.... preAuthRef 0..* string Prior authorization reference number
.... claimResponse C 0..1 Reference(ClaimResponse) Adjudication results
ref-1: SHALL have a contained resource if a local reference is provided
... accident 0..1 BackboneElement Details of the event
.... id 0..1 string Unique id for inter-element referencing
.... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... date 1..1 date When the incident occurred
.... type 0..1 CodeableConcept The nature of the accident
Binding: ActIncidentCode (extensible): Type of accident: work place, auto, etc.

.... location[x] 0..1 Where the event occurred
..... locationAddress Address
..... locationReference Reference(Location)
... item 0..* BackboneElement Product or service provided
.... id 0..1 string Unique id for inter-element referencing
.... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... sequence 1..1 positiveInt Item instance identifier
.... careTeamSequence 0..* positiveInt Applicable careTeam members
.... diagnosisSequence 0..* positiveInt Applicable diagnoses
.... procedureSequence 0..* positiveInt Applicable procedures
.... informationSequence 0..* positiveInt Applicable exception and supporting information
.... revenue 0..1 CodeableConcept Revenue or cost center code
Binding: ExampleRevenueCenterCodes (example): Codes for the revenue or cost centers supplying the service and/or products.

.... category 0..1 CodeableConcept Benefit classification
Binding: BenefitCategoryCodes (example): Benefit categories such as: oral-basic, major, glasses.

.... productOrService 1..1 CodeableConcept Billing, service, product, or drug code
Binding: USCLSCodes (example): Allowable service and product codes.

.... modifier 0..* CodeableConcept Product or service 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 C 0..1 SimpleQuantity Count of products or services
qty-3: If a code for the unit is present, the system SHALL also be present
sqty-1: The comparator is not used on a SimpleQuantity
.... unitPrice 0..1 Money Fee, charge or cost per item
.... factor 0..1 decimal Price scaling factor
.... net 0..1 Money Total item cost
.... udi C 0..* Reference(Device) Unique device identifier
ref-1: SHALL have a contained resource if a local reference is provided
.... bodySite 0..1 CodeableConcept Anatomical location
Binding: OralSiteCodes (example): The code for the teeth, quadrant, sextant and arch.

.... subSite 0..* CodeableConcept Anatomical sub-location
Binding: SurfaceCodes (example): The code for the tooth surface and surface combinations.


.... encounter C 0..* Reference(Encounter) Encounters related to this billed item
ref-1: SHALL have a contained resource if a local reference is provided
.... detail 0..* BackboneElement Product or service provided
..... id 0..1 string Unique id for inter-element referencing
..... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... sequence 1..1 positiveInt Item instance identifier
..... revenue 0..1 CodeableConcept Revenue or cost center code
Binding: ExampleRevenueCenterCodes (example): Codes for the revenue or cost centers supplying the service and/or products.

..... category 0..1 CodeableConcept Benefit classification
Binding: BenefitCategoryCodes (example): Benefit categories such as: oral-basic, major, glasses.

..... productOrService 1..1 CodeableConcept 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.


..... quantity C 0..1 SimpleQuantity Count of products or services
qty-3: If a code for the unit is present, the system SHALL also be present
sqty-1: The comparator is not used on a SimpleQuantity
..... unitPrice 0..1 Money Fee, charge or cost per item
..... factor 0..1 decimal Price scaling factor
..... net 0..1 Money Total item cost
..... udi C 0..* Reference(Device) Unique device identifier
ref-1: SHALL have a contained resource if a local reference is provided
..... subDetail 0..* BackboneElement Product or service provided
...... id 0..1 string Unique id for inter-element referencing
...... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... sequence 1..1 positiveInt Item instance identifier
...... revenue 0..1 CodeableConcept Revenue or cost center code
Binding: ExampleRevenueCenterCodes (example): Codes for the revenue or cost centers supplying the service and/or products.

...... category 0..1 CodeableConcept Benefit classification
Binding: BenefitCategoryCodes (example): Benefit categories such as: oral-basic, major, glasses.

...... productOrService 1..1 CodeableConcept 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.


...... quantity C 0..1 SimpleQuantity Count of products or services
qty-3: If a code for the unit is present, the system SHALL also be present
sqty-1: The comparator is not used on a SimpleQuantity
...... unitPrice 0..1 Money Fee, charge or cost per item
...... factor 0..1 decimal Price scaling factor
...... net 0..1 Money Total item cost
...... udi C 0..* Reference(Device) Unique device identifier
ref-1: SHALL have a contained resource if a local reference is provided
... total 0..1 Money Total claim cost

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Claim.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Claim.identifier:priorAuthNo.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Claim.identifier:priorAuthNo.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Claim.identifier:authId.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Claim.identifier:authId.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Claim.statusrequiredFinancialResourceStatusCodes
http://hl7.org/fhir/ValueSet/fm-status|4.0.1
from the FHIR Standard
Claim.typeextensiblePattern: professional
http://hl7.org/fhir/ValueSet/claim-type
from the FHIR Standard
Claim.subTypeexampleExampleClaimSubTypeCodes
http://hl7.org/fhir/ValueSet/claim-subtype
from the FHIR Standard
Claim.userequiredPattern: preauthorization
http://hl7.org/fhir/ValueSet/claim-use|4.0.1
from the FHIR Standard
Claim.priorityexamplePattern: normal
http://hl7.org/fhir/ValueSet/process-priority
from the FHIR Standard
Claim.fundsReserveexampleFunds Reservation Codes
http://hl7.org/fhir/ValueSet/fundsreserve
from the FHIR Standard
Claim.related.relationshipexampleExampleRelatedClaimRelationshipCodes
http://hl7.org/fhir/ValueSet/related-claim-relationship
from the FHIR Standard
Claim.payee.typeexampleClaim Payee Type Codes
http://hl7.org/fhir/ValueSet/payeetype
from the FHIR Standard
Claim.careTeam.roleexampleClaimCareTeamRoleCodes
http://hl7.org/fhir/ValueSet/claim-careteamrole
from the FHIR Standard
Claim.careTeam.qualificationexampleExampleProviderQualificationCodes
http://hl7.org/fhir/ValueSet/provider-qualification
from the FHIR Standard
Claim.supportingInfo.categoryexampleClaimInformationCategoryCodes
http://hl7.org/fhir/ValueSet/claim-informationcategory
from the FHIR Standard
Claim.supportingInfo.codeexampleExceptionCodes
http://hl7.org/fhir/ValueSet/claim-exception
from the FHIR Standard
Claim.supportingInfo.reasonexampleMissingToothReasonCodes
http://hl7.org/fhir/ValueSet/missing-tooth-reason
from the FHIR Standard
Claim.diagnosis.diagnosis[x]exampleICD-10Codes
http://hl7.org/fhir/ValueSet/icd-10
from the FHIR Standard
Claim.diagnosis.typeexampleExampleDiagnosisTypeCodes
http://hl7.org/fhir/ValueSet/ex-diagnosistype
from the FHIR Standard
Claim.diagnosis.onAdmissionexampleExampleDiagnosisOnAdmissionCodes
http://hl7.org/fhir/ValueSet/ex-diagnosis-on-admission
from the FHIR Standard
Claim.diagnosis.packageCodeexampleExampleDiagnosisRelatedGroupCodes
http://hl7.org/fhir/ValueSet/ex-diagnosisrelatedgroup
from the FHIR Standard
Claim.procedure.typeexampleExampleProcedureTypeCodes
http://hl7.org/fhir/ValueSet/ex-procedure-type
from the FHIR Standard
Claim.procedure.procedure[x]exampleICD-10ProcedureCodes
http://hl7.org/fhir/ValueSet/icd-10-procedures
from the FHIR Standard
Claim.accident.typeextensibleActIncidentCode
http://terminology.hl7.org/ValueSet/v3-ActIncidentCode
Claim.item.revenueexampleExampleRevenueCenterCodes
http://hl7.org/fhir/ValueSet/ex-revenue-center
from the FHIR Standard
Claim.item.categoryexampleBenefitCategoryCodes
http://hl7.org/fhir/ValueSet/ex-benefitcategory
from the FHIR Standard
Claim.item.productOrServiceexampleUSCLSCodes
http://hl7.org/fhir/ValueSet/service-uscls
from the FHIR Standard
Claim.item.modifierexampleModifierTypeCodes
http://hl7.org/fhir/ValueSet/claim-modifiers
from the FHIR Standard
Claim.item.programCodeexampleExampleProgramReasonCodes
http://hl7.org/fhir/ValueSet/ex-program-code
from the FHIR Standard
Claim.item.location[x]exampleExampleServicePlaceCodes
http://hl7.org/fhir/ValueSet/service-place
from the FHIR Standard
Claim.item.bodySiteexampleOralSiteCodes
http://hl7.org/fhir/ValueSet/tooth
from the FHIR Standard
Claim.item.subSiteexampleSurfaceCodes
http://hl7.org/fhir/ValueSet/surface
from the FHIR Standard
Claim.item.detail.revenueexampleExampleRevenueCenterCodes
http://hl7.org/fhir/ValueSet/ex-revenue-center
from the FHIR Standard
Claim.item.detail.categoryexampleBenefitCategoryCodes
http://hl7.org/fhir/ValueSet/ex-benefitcategory
from the FHIR Standard
Claim.item.detail.productOrServiceexampleUSCLSCodes
http://hl7.org/fhir/ValueSet/service-uscls
from the FHIR Standard
Claim.item.detail.modifierexampleModifierTypeCodes
http://hl7.org/fhir/ValueSet/claim-modifiers
from the FHIR Standard
Claim.item.detail.programCodeexampleExampleProgramReasonCodes
http://hl7.org/fhir/ValueSet/ex-program-code
from the FHIR Standard
Claim.item.detail.subDetail.revenueexampleExampleRevenueCenterCodes
http://hl7.org/fhir/ValueSet/ex-revenue-center
from the FHIR Standard
Claim.item.detail.subDetail.categoryexampleBenefitCategoryCodes
http://hl7.org/fhir/ValueSet/ex-benefitcategory
from the FHIR Standard
Claim.item.detail.subDetail.productOrServiceexampleUSCLSCodes
http://hl7.org/fhir/ValueSet/service-uscls
from the FHIR Standard
Claim.item.detail.subDetail.modifierexampleModifierTypeCodes
http://hl7.org/fhir/ValueSet/claim-modifiers
from the FHIR Standard
Claim.item.detail.subDetail.programCodeexampleExampleProgramReasonCodes
http://hl7.org/fhir/ValueSet/ex-program-code
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorClaimIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorClaimIf 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-4errorClaimIf 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-5errorClaimIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceClaimA 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** elementsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
per-1errorClaim.identifier:priorAuthNo.period, Claim.identifier:authId.period, Claim.billablePeriodIf present, start SHALL have a lower value than end
: start.hasValue().not() or end.hasValue().not() or (start <= end)
qty-3errorClaim.item.quantity, Claim.item.detail.quantity, Claim.item.detail.subDetail.quantityIf a code for the unit is present, the system SHALL also be present
: code.empty() or system.exists()
ref-1errorClaim.identifier:priorAuthNo.assigner, Claim.identifier:authId.assigner, Claim.patient, Claim.enterer, Claim.insurer, Claim.provider, Claim.related.claim, Claim.prescription, Claim.originalPrescription, Claim.payee.party, Claim.referral, Claim.facility, Claim.careTeam.provider, Claim.procedure.udi, Claim.insurance.coverage, Claim.insurance.claimResponse, Claim.item.udi, Claim.item.encounter, Claim.item.detail.udi, Claim.item.detail.subDetail.udiSHALL have a contained resource if a local reference is provided
: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
sqty-1errorClaim.item.quantity, Claim.item.detail.quantity, Claim.item.detail.subDetail.quantityThe comparator is not used on a SimpleQuantity
: comparator.empty()

This structure is derived from Claim

Summary

Mandatory: 4 elements(2 nested mandatory elements)
Must-Support: 6 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Claim.identifier
  • The element 1 is sliced based on the value of Claim.supportingInfo.timing[x]

 

Other representations of profile: CSV, Excel, Schematron