CH Core (R4)
6.0.0-ballot-ci-build - ci-build
CH Core (R4), published by HL7 Switzerland. This guide is not an authorized publication; it is the continuous build for version 6.0.0-ballot-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7ch/ch-core/ and changes regularly. See the Directory of published versions
Official URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-claim | Version: 6.0.0-ballot-ci-build | |||
Active as of 2024-12-18 | Computable Name: CHCoreClaim | |||
Copyright/Legal: CC0-1.0 |
Base definition of the claim resource for the representation of a list of professional services (e.g. doctor's visit) and products (e.g. medication) that have been or are to be provided for a patient. The profile defines general basic elements that can occur in Swiss use cases. In Switzerland, there are external standards for administrative processes between service providers and payers (e.g. Forum Datenaustausch, SHIP, eCH), therefore see the corresponding mapping.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Claim
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Claim | 0..* | Claim | Claim, Pre-determination or Pre-authorization | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
biller | 0..1 | Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization) | Biller in the case of a professional service or poduct provided. URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-biller | |
identifier | 0..* | Identifier | Business Identifier for claim | |
type | 1..1 | CodeableConcept | Category or discipline Binding: BFS Medizinische Statistik - 20 1.3.V01 - Behandlungsart / Type de prise en charge / Genere di trattamento (extensible) | |
patient | 1..1 | Reference(CH Core Patient) | The recipient of the products and services | |
created | 1..1 | dateTime | Resource creation date | |
provider | 1..1 | Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization) | Party responsible for the claim | |
Slices for supportingInfo | 0..* | BackboneElement | Supporting information Slice: Unordered, Open by value:category | |
supportingInfo:treatmentReason | 0..1 | BackboneElement | Supporting information | |
category | 1..1 | CodeableConcept | Classification of the supplied information 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/claiminformationcategory | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: patientreasonforvisit | |
code | 1..1 | CodeableConcept | Treatment reason Binding: Treatment Reason (preferred) | |
supportingInfo:remark | 0..1 | BackboneElement | Supporting information | |
category | 1..1 | CodeableConcept | Classification of the supplied information 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/claiminformationcategory | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: info | |
Slices for value[x] | 1..1 | string | Data to be provided Slice: Unordered, Open by type:$this | |
value[x]:valueString | 1..1 | string | Remark | |
diagnosis | ||||
diagnosis[x] | 1..1 | CodeableConcept, Reference(Condition) | Nature of illness or problem | |
insurance | ||||
coverage | 1..1 | Reference(CH Core Coverage) | Insurance information | |
item | ||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
responsible | 0..1 | Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization) | Responsible for the service or product provided URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-responsible | |
sequence | 1..1 | positiveInt | Item instance identifier | |
category | ||||
Slices for coding | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
coding:tariff | 0..1 | Coding | Tariff | |
system | 1..1 | uri | Identity of the terminology system Required Pattern: http://forum-datenaustausch.ch/tariff | |
code | 0..1 | code | Symbol in syntax defined by the system | |
productOrService | 1..1 | CodeableConcept | Tariff number | |
Slices for coding | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
coding:All Slices | Content/Rules for all slices | |||
code | 0..1 | code | Symbol in syntax defined by the system | |
display | 0..1 | string | Representation defined by the system | |
coding:GTIN | 0..1 | Coding | Code defined by a terminology system | |
system | 1..1 | uri | Identity of the terminology system Required Pattern: urn:oid:2.51.1.1 | |
coding:TARMED | 0..1 | Coding | Code defined by a terminology system | |
system | 1..1 | uri | Identity of the terminology system Required Pattern: urn:oid:2.16.756.5.30.1.129.1.4 | |
serviced[x] | 0..1 | date, Period | Date or dates of service or product delivery | |
quantity | ||||
value | 0..1 | decimal | Numerical value (with implicit precision) | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Claim.type | extensible | BfsMedstats20Encounterclasshttp://fhir.ch/ig/ch-core/ValueSet/bfs-medstats-20-encounterclass | |
Claim.supportingInfo:treatmentReason.code | preferred | TreatmentReasonhttp://fhir.ch/ig/ch-term/ValueSet/treatmentreason |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
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 | 0..* | 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 | |
biller | 0..1 | Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization) | Biller in the case of a professional service or poduct provided. URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-biller ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
identifier | 0..* | Identifier | Business Identifier for claim ele-1: All FHIR elements must have a @value or children | |
status | ?!Σ | 1..1 | code | active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. ele-1: All FHIR elements must have a @value or children |
type | Σ | 1..1 | CodeableConcept | Category or discipline Binding: BFS Medizinische Statistik - 20 1.3.V01 - Behandlungsart / Type de prise en charge / Genere di trattamento (extensible) ele-1: All FHIR elements must have a @value or children |
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 |
patient | Σ | 1..1 | Reference(CH Core Patient) | The recipient of the products and services ele-1: All FHIR elements must have a @value or children |
created | Σ | 1..1 | dateTime | Resource creation date ele-1: All FHIR elements must have a @value or children |
provider | Σ | 1..1 | Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization) | Party responsible for the claim ele-1: All FHIR elements must have a @value or children |
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 |
Slices for supportingInfo | 0..* | BackboneElement | Supporting information Slice: Unordered, Open by value:category ele-1: All FHIR elements must have a @value or children | |
supportingInfo:All Slices | Content/Rules for all slices | |||
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 | |
supportingInfo:treatmentReason | 0..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 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/claiminformationcategory | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: patientreasonforvisit | |
code | 1..1 | CodeableConcept | Treatment reason Binding: Treatment Reason (preferred) ele-1: All FHIR elements must have a @value or children | |
supportingInfo:remark | 0..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 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/claiminformationcategory | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: info | |
Slices for value[x] | 1..1 | string | Data to be provided Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children | |
value[x]:valueString | 1..1 | string | Remark 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 | Σ | 1..1 | Reference(CH Core Coverage) | Insurance information ele-1: All FHIR elements must have a @value or children |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Claim.status | required | FinancialResourceStatusCodeshttp://hl7.org/fhir/ValueSet/fm-status|4.0.1 from the FHIR Standard | |
Claim.type | extensible | BfsMedstats20Encounterclasshttp://fhir.ch/ig/ch-core/ValueSet/bfs-medstats-20-encounterclass | |
Claim.use | required | Usehttp://hl7.org/fhir/ValueSet/claim-use|4.0.1 from the FHIR Standard | |
Claim.priority | example | ProcessPriorityCodeshttp://hl7.org/fhir/ValueSet/process-priority from the FHIR Standard | |
Claim.supportingInfo.category | example | ClaimInformationCategoryCodeshttp://hl7.org/fhir/ValueSet/claim-informationcategory from the FHIR Standard | |
Claim.supportingInfo:treatmentReason.category | example | Pattern: patientreasonforvisithttp://hl7.org/fhir/ValueSet/claim-informationcategory from the FHIR Standard | |
Claim.supportingInfo:treatmentReason.code | preferred | TreatmentReasonhttp://fhir.ch/ig/ch-term/ValueSet/treatmentreason | |
Claim.supportingInfo:remark.category | example | Pattern: infohttp://hl7.org/fhir/ValueSet/claim-informationcategory from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Claim | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Claim | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Claim | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Claim | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Claim | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
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.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
biller | 0..1 | Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization) | Biller in the case of a professional service or poduct provided. URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-biller | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | 0..* | Identifier | Business Identifier for claim | |||||
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: BFS Medizinische Statistik - 20 1.3.V01 - Behandlungsart / Type de prise en charge / Genere di trattamento (extensible) | ||||
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. | ||||
patient | Σ | 1..1 | Reference(CH Core Patient) | The recipient of the products and services | ||||
billablePeriod | Σ | 0..1 | Period | Relevant time frame for the claim | ||||
created | Σ | 1..1 | dateTime | Resource creation date | ||||
enterer | 0..1 | Reference(Practitioner | PractitionerRole) | Author of the claim | |||||
insurer | Σ | 0..1 | Reference(Organization) | Target | ||||
provider | Σ | 1..1 | Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization) | Party responsible for the claim | ||||
priority | Σ | 1..1 | CodeableConcept | Desired processing ugency Binding: ProcessPriorityCodes (example): The timeliness with which processing is required: stat, normal, deferred. | ||||
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 | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
claim | 0..1 | Reference(Claim) | Reference to the related claim | |||||
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 | 0..1 | Reference(DeviceRequest | MedicationRequest | VisionPrescription) | Prescription authorizing services and products | |||||
originalPrescription | 0..1 | Reference(DeviceRequest | MedicationRequest | VisionPrescription) | Original prescription if superseded by fulfiller | |||||
payee | 0..1 | BackboneElement | Recipient of benefits payable | |||||
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 | Category of recipient Binding: Claim Payee Type Codes (example): A code for the party to be reimbursed. | |||||
party | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson) | Recipient reference | |||||
referral | 0..1 | Reference(ServiceRequest) | Treatment referral | |||||
facility | 0..1 | Reference(Location) | Servicing facility | |||||
careTeam | 0..* | BackboneElement | Members of the care team | |||||
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 | positiveInt | Order of care team | |||||
provider | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Practitioner or organization | |||||
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. | |||||
Slices for supportingInfo | 0..* | BackboneElement | Supporting information Slice: Unordered, Open by value:category | |||||
supportingInfo:All Slices | Content/Rules for all slices | |||||||
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 | 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. | |||||
timing[x] | 0..1 | When it occurred | ||||||
timingDate | date | |||||||
timingPeriod | Period | |||||||
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. | |||||
supportingInfo:treatmentReason | 0..1 | BackboneElement | Supporting 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 | positiveInt | Information instance identifier | |||||
category | 1..1 | CodeableConcept | Classification of the supplied information Binding: ClaimInformationCategoryCodes (example): The valuset used for additional information category codes. 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/claiminformationcategory | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: patientreasonforvisit | |||||
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 | |||||
code | 1..1 | CodeableConcept | Treatment reason Binding: Treatment Reason (preferred) | |||||
timing[x] | 0..1 | When it occurred | ||||||
timingDate | date | |||||||
timingPeriod | Period | |||||||
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. | |||||
supportingInfo:remark | 0..1 | BackboneElement | Supporting 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 | positiveInt | Information instance identifier | |||||
category | 1..1 | CodeableConcept | Classification of the supplied information Binding: ClaimInformationCategoryCodes (example): The valuset used for additional information category codes. 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/claiminformationcategory | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: info | |||||
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 | |||||
code | 0..1 | CodeableConcept | Type of information Binding: ExceptionCodes (example): The valuset used for additional information codes. | |||||
timing[x] | 0..1 | When it occurred | ||||||
timingDate | date | |||||||
timingPeriod | Period | |||||||
Slices for value[x] | 1..1 | string | Data to be provided Slice: Unordered, Closed by type:$this | |||||
value[x]:valueString | 1..1 | string | Remark | |||||
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 | 0..* | Extension | Additional content defined by implementations | |||||
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 | 0..* | Extension | Additional content defined by implementations | |||||
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 | 0..* | Reference(Device) | Unique device identifier | |||||
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 | positiveInt | Insurance instance identifier | ||||
focal | Σ | 1..1 | boolean | Coverage to be used for adjudication | ||||
identifier | 0..1 | Identifier | Pre-assigned Claim number | |||||
coverage | Σ | 1..1 | Reference(CH Core Coverage) | Insurance information | ||||
businessArrangement | 0..1 | string | Additional provider contract number | |||||
preAuthRef | 0..* | string | Prior authorization reference number | |||||
claimResponse | 0..1 | Reference(ClaimResponse) | Adjudication results | |||||
accident | 0..1 | BackboneElement | Details of the event | |||||
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 | ||||
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 | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
responsible | 0..1 | Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization) | Responsible for the service or product provided URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-responsible | |||||
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. | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
coding:tariff | Σ | 0..1 | Coding | Tariff | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://forum-datenaustausch.ch/tariff | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
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 | ||||
productOrService | 1..1 | CodeableConcept | Tariff number Binding: USCLSCodes (example): Allowable service and product codes. | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
coding:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
coding:GTIN | Σ | 0..1 | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: urn:oid:2.51.1.1 | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
coding:TARMED | Σ | 0..1 | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: urn:oid:2.16.756.5.30.1.129.1.4 | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
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 | ||||
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 | 0..1 | SimpleQuantity | Count of products or 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 | |||||
value | Σ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
unit | Σ | 0..1 | string | Unit representation | ||||
system | ΣC | 0..1 | uri | System that defines coded unit form | ||||
code | Σ | 0..1 | code | Coded form of the unit | ||||
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 | 0..* | Reference(Device) | Unique device identifier | |||||
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 | 0..* | Reference(Encounter) | Encounters related to this billed item | |||||
detail | 0..* | BackboneElement | Product or service provided | |||||
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 | 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 | 0..1 | SimpleQuantity | 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 | |||||
udi | 0..* | Reference(Device) | Unique device identifier | |||||
subDetail | 0..* | BackboneElement | Product or service provided | |||||
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 | 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 | 0..1 | SimpleQuantity | 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 | |||||
udi | 0..* | Reference(Device) | Unique device identifier | |||||
total | 0..1 | Money | Total claim cost | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
Claim.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Claim.status | required | FinancialResourceStatusCodeshttp://hl7.org/fhir/ValueSet/fm-status|4.0.1 from the FHIR Standard | ||||
Claim.type | extensible | BfsMedstats20Encounterclasshttp://fhir.ch/ig/ch-core/ValueSet/bfs-medstats-20-encounterclass | ||||
Claim.subType | example | ExampleClaimSubTypeCodeshttp://hl7.org/fhir/ValueSet/claim-subtype from the FHIR Standard | ||||
Claim.use | required | Usehttp://hl7.org/fhir/ValueSet/claim-use|4.0.1 from the FHIR Standard | ||||
Claim.priority | example | ProcessPriorityCodeshttp://hl7.org/fhir/ValueSet/process-priority from the FHIR Standard | ||||
Claim.fundsReserve | example | Funds Reservation Codeshttp://hl7.org/fhir/ValueSet/fundsreserve from the FHIR Standard | ||||
Claim.related.relationship | example | ExampleRelatedClaimRelationshipCodeshttp://hl7.org/fhir/ValueSet/related-claim-relationship from the FHIR Standard | ||||
Claim.payee.type | example | Claim Payee Type Codeshttp://hl7.org/fhir/ValueSet/payeetype from the FHIR Standard | ||||
Claim.careTeam.role | example | ClaimCareTeamRoleCodeshttp://hl7.org/fhir/ValueSet/claim-careteamrole from the FHIR Standard | ||||
Claim.careTeam.qualification | example | ExampleProviderQualificationCodeshttp://hl7.org/fhir/ValueSet/provider-qualification from the FHIR Standard | ||||
Claim.supportingInfo.category | example | ClaimInformationCategoryCodeshttp://hl7.org/fhir/ValueSet/claim-informationcategory from the FHIR Standard | ||||
Claim.supportingInfo.code | example | ExceptionCodeshttp://hl7.org/fhir/ValueSet/claim-exception from the FHIR Standard | ||||
Claim.supportingInfo.reason | example | MissingToothReasonCodeshttp://hl7.org/fhir/ValueSet/missing-tooth-reason from the FHIR Standard | ||||
Claim.supportingInfo:treatmentReason.category | example | Pattern: patientreasonforvisithttp://hl7.org/fhir/ValueSet/claim-informationcategory from the FHIR Standard | ||||
Claim.supportingInfo:treatmentReason.code | preferred | TreatmentReasonhttp://fhir.ch/ig/ch-term/ValueSet/treatmentreason | ||||
Claim.supportingInfo:treatmentReason.reason | example | MissingToothReasonCodeshttp://hl7.org/fhir/ValueSet/missing-tooth-reason from the FHIR Standard | ||||
Claim.supportingInfo:remark.category | example | Pattern: infohttp://hl7.org/fhir/ValueSet/claim-informationcategory from the FHIR Standard | ||||
Claim.supportingInfo:remark.code | example | ExceptionCodeshttp://hl7.org/fhir/ValueSet/claim-exception from the FHIR Standard | ||||
Claim.supportingInfo:remark.reason | example | MissingToothReasonCodeshttp://hl7.org/fhir/ValueSet/missing-tooth-reason from the FHIR Standard | ||||
Claim.diagnosis.diagnosis[x] | example | ICD-10Codeshttp://hl7.org/fhir/ValueSet/icd-10 from the FHIR Standard | ||||
Claim.diagnosis.type | example | ExampleDiagnosisTypeCodeshttp://hl7.org/fhir/ValueSet/ex-diagnosistype from the FHIR Standard | ||||
Claim.diagnosis.onAdmission | example | ExampleDiagnosisOnAdmissionCodeshttp://hl7.org/fhir/ValueSet/ex-diagnosis-on-admission from the FHIR Standard | ||||
Claim.diagnosis.packageCode | example | ExampleDiagnosisRelatedGroupCodeshttp://hl7.org/fhir/ValueSet/ex-diagnosisrelatedgroup from the FHIR Standard | ||||
Claim.procedure.type | example | ExampleProcedureTypeCodeshttp://hl7.org/fhir/ValueSet/ex-procedure-type from the FHIR Standard | ||||
Claim.procedure.procedure[x] | example | ICD-10ProcedureCodeshttp://hl7.org/fhir/ValueSet/icd-10-procedures from the FHIR Standard | ||||
Claim.accident.type | extensible | ActIncidentCodehttp://terminology.hl7.org/ValueSet/v3-ActIncidentCode | ||||
Claim.item.revenue | example | ExampleRevenueCenterCodeshttp://hl7.org/fhir/ValueSet/ex-revenue-center from the FHIR Standard | ||||
Claim.item.category | example | BenefitCategoryCodeshttp://hl7.org/fhir/ValueSet/ex-benefitcategory from the FHIR Standard | ||||
Claim.item.productOrService | example | USCLSCodeshttp://hl7.org/fhir/ValueSet/service-uscls from the FHIR Standard | ||||
Claim.item.modifier | example | ModifierTypeCodeshttp://hl7.org/fhir/ValueSet/claim-modifiers from the FHIR Standard | ||||
Claim.item.programCode | example | ExampleProgramReasonCodeshttp://hl7.org/fhir/ValueSet/ex-program-code from the FHIR Standard | ||||
Claim.item.location[x] | example | ExampleServicePlaceCodeshttp://hl7.org/fhir/ValueSet/service-place from the FHIR Standard | ||||
Claim.item.bodySite | example | OralSiteCodeshttp://hl7.org/fhir/ValueSet/tooth from the FHIR Standard | ||||
Claim.item.subSite | example | SurfaceCodeshttp://hl7.org/fhir/ValueSet/surface from the FHIR Standard | ||||
Claim.item.detail.revenue | example | ExampleRevenueCenterCodeshttp://hl7.org/fhir/ValueSet/ex-revenue-center from the FHIR Standard | ||||
Claim.item.detail.category | example | BenefitCategoryCodeshttp://hl7.org/fhir/ValueSet/ex-benefitcategory from the FHIR Standard | ||||
Claim.item.detail.productOrService | example | USCLSCodeshttp://hl7.org/fhir/ValueSet/service-uscls from the FHIR Standard | ||||
Claim.item.detail.modifier | example | ModifierTypeCodeshttp://hl7.org/fhir/ValueSet/claim-modifiers from the FHIR Standard | ||||
Claim.item.detail.programCode | example | ExampleProgramReasonCodeshttp://hl7.org/fhir/ValueSet/ex-program-code from the FHIR Standard | ||||
Claim.item.detail.subDetail.revenue | example | ExampleRevenueCenterCodeshttp://hl7.org/fhir/ValueSet/ex-revenue-center from the FHIR Standard | ||||
Claim.item.detail.subDetail.category | example | BenefitCategoryCodeshttp://hl7.org/fhir/ValueSet/ex-benefitcategory from the FHIR Standard | ||||
Claim.item.detail.subDetail.productOrService | example | USCLSCodeshttp://hl7.org/fhir/ValueSet/service-uscls from the FHIR Standard | ||||
Claim.item.detail.subDetail.modifier | example | ModifierTypeCodeshttp://hl7.org/fhir/ValueSet/claim-modifiers from the FHIR Standard | ||||
Claim.item.detail.subDetail.programCode | example | ExampleProgramReasonCodeshttp://hl7.org/fhir/ValueSet/ex-program-code from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Claim | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Claim | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Claim | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Claim | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Claim | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Claim
Summary
Mandatory: 0 element(6 nested mandatory elements)
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Claim
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Claim | 0..* | Claim | Claim, Pre-determination or Pre-authorization | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
biller | 0..1 | Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization) | Biller in the case of a professional service or poduct provided. URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-biller | |
identifier | 0..* | Identifier | Business Identifier for claim | |
type | 1..1 | CodeableConcept | Category or discipline Binding: BFS Medizinische Statistik - 20 1.3.V01 - Behandlungsart / Type de prise en charge / Genere di trattamento (extensible) | |
patient | 1..1 | Reference(CH Core Patient) | The recipient of the products and services | |
created | 1..1 | dateTime | Resource creation date | |
provider | 1..1 | Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization) | Party responsible for the claim | |
Slices for supportingInfo | 0..* | BackboneElement | Supporting information Slice: Unordered, Open by value:category | |
supportingInfo:treatmentReason | 0..1 | BackboneElement | Supporting information | |
category | 1..1 | CodeableConcept | Classification of the supplied information 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/claiminformationcategory | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: patientreasonforvisit | |
code | 1..1 | CodeableConcept | Treatment reason Binding: Treatment Reason (preferred) | |
supportingInfo:remark | 0..1 | BackboneElement | Supporting information | |
category | 1..1 | CodeableConcept | Classification of the supplied information 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/claiminformationcategory | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: info | |
Slices for value[x] | 1..1 | string | Data to be provided Slice: Unordered, Open by type:$this | |
value[x]:valueString | 1..1 | string | Remark | |
diagnosis | ||||
diagnosis[x] | 1..1 | CodeableConcept, Reference(Condition) | Nature of illness or problem | |
insurance | ||||
coverage | 1..1 | Reference(CH Core Coverage) | Insurance information | |
item | ||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
responsible | 0..1 | Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization) | Responsible for the service or product provided URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-responsible | |
sequence | 1..1 | positiveInt | Item instance identifier | |
category | ||||
Slices for coding | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
coding:tariff | 0..1 | Coding | Tariff | |
system | 1..1 | uri | Identity of the terminology system Required Pattern: http://forum-datenaustausch.ch/tariff | |
code | 0..1 | code | Symbol in syntax defined by the system | |
productOrService | 1..1 | CodeableConcept | Tariff number | |
Slices for coding | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
coding:All Slices | Content/Rules for all slices | |||
code | 0..1 | code | Symbol in syntax defined by the system | |
display | 0..1 | string | Representation defined by the system | |
coding:GTIN | 0..1 | Coding | Code defined by a terminology system | |
system | 1..1 | uri | Identity of the terminology system Required Pattern: urn:oid:2.51.1.1 | |
coding:TARMED | 0..1 | Coding | Code defined by a terminology system | |
system | 1..1 | uri | Identity of the terminology system Required Pattern: urn:oid:2.16.756.5.30.1.129.1.4 | |
serviced[x] | 0..1 | date, Period | Date or dates of service or product delivery | |
quantity | ||||
value | 0..1 | decimal | Numerical value (with implicit precision) | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Claim.type | extensible | BfsMedstats20Encounterclasshttp://fhir.ch/ig/ch-core/ValueSet/bfs-medstats-20-encounterclass | |
Claim.supportingInfo:treatmentReason.code | preferred | TreatmentReasonhttp://fhir.ch/ig/ch-term/ValueSet/treatmentreason |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
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 | 0..* | 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 | |
biller | 0..1 | Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization) | Biller in the case of a professional service or poduct provided. URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-biller ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
identifier | 0..* | Identifier | Business Identifier for claim ele-1: All FHIR elements must have a @value or children | |
status | ?!Σ | 1..1 | code | active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. ele-1: All FHIR elements must have a @value or children |
type | Σ | 1..1 | CodeableConcept | Category or discipline Binding: BFS Medizinische Statistik - 20 1.3.V01 - Behandlungsart / Type de prise en charge / Genere di trattamento (extensible) ele-1: All FHIR elements must have a @value or children |
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 |
patient | Σ | 1..1 | Reference(CH Core Patient) | The recipient of the products and services ele-1: All FHIR elements must have a @value or children |
created | Σ | 1..1 | dateTime | Resource creation date ele-1: All FHIR elements must have a @value or children |
provider | Σ | 1..1 | Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization) | Party responsible for the claim ele-1: All FHIR elements must have a @value or children |
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 |
Slices for supportingInfo | 0..* | BackboneElement | Supporting information Slice: Unordered, Open by value:category ele-1: All FHIR elements must have a @value or children | |
supportingInfo:All Slices | Content/Rules for all slices | |||
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 | |
supportingInfo:treatmentReason | 0..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 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/claiminformationcategory | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: patientreasonforvisit | |
code | 1..1 | CodeableConcept | Treatment reason Binding: Treatment Reason (preferred) ele-1: All FHIR elements must have a @value or children | |
supportingInfo:remark | 0..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 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/claiminformationcategory | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: info | |
Slices for value[x] | 1..1 | string | Data to be provided Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children | |
value[x]:valueString | 1..1 | string | Remark 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 | Σ | 1..1 | Reference(CH Core Coverage) | Insurance information ele-1: All FHIR elements must have a @value or children |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Claim.status | required | FinancialResourceStatusCodeshttp://hl7.org/fhir/ValueSet/fm-status|4.0.1 from the FHIR Standard | |
Claim.type | extensible | BfsMedstats20Encounterclasshttp://fhir.ch/ig/ch-core/ValueSet/bfs-medstats-20-encounterclass | |
Claim.use | required | Usehttp://hl7.org/fhir/ValueSet/claim-use|4.0.1 from the FHIR Standard | |
Claim.priority | example | ProcessPriorityCodeshttp://hl7.org/fhir/ValueSet/process-priority from the FHIR Standard | |
Claim.supportingInfo.category | example | ClaimInformationCategoryCodeshttp://hl7.org/fhir/ValueSet/claim-informationcategory from the FHIR Standard | |
Claim.supportingInfo:treatmentReason.category | example | Pattern: patientreasonforvisithttp://hl7.org/fhir/ValueSet/claim-informationcategory from the FHIR Standard | |
Claim.supportingInfo:treatmentReason.code | preferred | TreatmentReasonhttp://fhir.ch/ig/ch-term/ValueSet/treatmentreason | |
Claim.supportingInfo:remark.category | example | Pattern: infohttp://hl7.org/fhir/ValueSet/claim-informationcategory from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Claim | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Claim | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Claim | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Claim | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Claim | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
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.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
biller | 0..1 | Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization) | Biller in the case of a professional service or poduct provided. URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-biller | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | 0..* | Identifier | Business Identifier for claim | |||||
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: BFS Medizinische Statistik - 20 1.3.V01 - Behandlungsart / Type de prise en charge / Genere di trattamento (extensible) | ||||
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. | ||||
patient | Σ | 1..1 | Reference(CH Core Patient) | The recipient of the products and services | ||||
billablePeriod | Σ | 0..1 | Period | Relevant time frame for the claim | ||||
created | Σ | 1..1 | dateTime | Resource creation date | ||||
enterer | 0..1 | Reference(Practitioner | PractitionerRole) | Author of the claim | |||||
insurer | Σ | 0..1 | Reference(Organization) | Target | ||||
provider | Σ | 1..1 | Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization) | Party responsible for the claim | ||||
priority | Σ | 1..1 | CodeableConcept | Desired processing ugency Binding: ProcessPriorityCodes (example): The timeliness with which processing is required: stat, normal, deferred. | ||||
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 | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
claim | 0..1 | Reference(Claim) | Reference to the related claim | |||||
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 | 0..1 | Reference(DeviceRequest | MedicationRequest | VisionPrescription) | Prescription authorizing services and products | |||||
originalPrescription | 0..1 | Reference(DeviceRequest | MedicationRequest | VisionPrescription) | Original prescription if superseded by fulfiller | |||||
payee | 0..1 | BackboneElement | Recipient of benefits payable | |||||
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 | Category of recipient Binding: Claim Payee Type Codes (example): A code for the party to be reimbursed. | |||||
party | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson) | Recipient reference | |||||
referral | 0..1 | Reference(ServiceRequest) | Treatment referral | |||||
facility | 0..1 | Reference(Location) | Servicing facility | |||||
careTeam | 0..* | BackboneElement | Members of the care team | |||||
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 | positiveInt | Order of care team | |||||
provider | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Practitioner or organization | |||||
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. | |||||
Slices for supportingInfo | 0..* | BackboneElement | Supporting information Slice: Unordered, Open by value:category | |||||
supportingInfo:All Slices | Content/Rules for all slices | |||||||
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 | 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. | |||||
timing[x] | 0..1 | When it occurred | ||||||
timingDate | date | |||||||
timingPeriod | Period | |||||||
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. | |||||
supportingInfo:treatmentReason | 0..1 | BackboneElement | Supporting 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 | positiveInt | Information instance identifier | |||||
category | 1..1 | CodeableConcept | Classification of the supplied information Binding: ClaimInformationCategoryCodes (example): The valuset used for additional information category codes. 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/claiminformationcategory | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: patientreasonforvisit | |||||
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 | |||||
code | 1..1 | CodeableConcept | Treatment reason Binding: Treatment Reason (preferred) | |||||
timing[x] | 0..1 | When it occurred | ||||||
timingDate | date | |||||||
timingPeriod | Period | |||||||
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. | |||||
supportingInfo:remark | 0..1 | BackboneElement | Supporting 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 | positiveInt | Information instance identifier | |||||
category | 1..1 | CodeableConcept | Classification of the supplied information Binding: ClaimInformationCategoryCodes (example): The valuset used for additional information category codes. 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/claiminformationcategory | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: info | |||||
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 | |||||
code | 0..1 | CodeableConcept | Type of information Binding: ExceptionCodes (example): The valuset used for additional information codes. | |||||
timing[x] | 0..1 | When it occurred | ||||||
timingDate | date | |||||||
timingPeriod | Period | |||||||
Slices for value[x] | 1..1 | string | Data to be provided Slice: Unordered, Closed by type:$this | |||||
value[x]:valueString | 1..1 | string | Remark | |||||
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 | 0..* | Extension | Additional content defined by implementations | |||||
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 | 0..* | Extension | Additional content defined by implementations | |||||
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 | 0..* | Reference(Device) | Unique device identifier | |||||
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 | positiveInt | Insurance instance identifier | ||||
focal | Σ | 1..1 | boolean | Coverage to be used for adjudication | ||||
identifier | 0..1 | Identifier | Pre-assigned Claim number | |||||
coverage | Σ | 1..1 | Reference(CH Core Coverage) | Insurance information | ||||
businessArrangement | 0..1 | string | Additional provider contract number | |||||
preAuthRef | 0..* | string | Prior authorization reference number | |||||
claimResponse | 0..1 | Reference(ClaimResponse) | Adjudication results | |||||
accident | 0..1 | BackboneElement | Details of the event | |||||
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 | ||||
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 | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
responsible | 0..1 | Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization) | Responsible for the service or product provided URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-responsible | |||||
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. | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
coding:tariff | Σ | 0..1 | Coding | Tariff | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://forum-datenaustausch.ch/tariff | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
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 | ||||
productOrService | 1..1 | CodeableConcept | Tariff number Binding: USCLSCodes (example): Allowable service and product codes. | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
coding:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
coding:GTIN | Σ | 0..1 | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: urn:oid:2.51.1.1 | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
coding:TARMED | Σ | 0..1 | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: urn:oid:2.16.756.5.30.1.129.1.4 | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
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 | ||||
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 | 0..1 | SimpleQuantity | Count of products or 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 | |||||
value | Σ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
unit | Σ | 0..1 | string | Unit representation | ||||
system | ΣC | 0..1 | uri | System that defines coded unit form | ||||
code | Σ | 0..1 | code | Coded form of the unit | ||||
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 | 0..* | Reference(Device) | Unique device identifier | |||||
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 | 0..* | Reference(Encounter) | Encounters related to this billed item | |||||
detail | 0..* | BackboneElement | Product or service provided | |||||
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 | 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 | 0..1 | SimpleQuantity | 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 | |||||
udi | 0..* | Reference(Device) | Unique device identifier | |||||
subDetail | 0..* | BackboneElement | Product or service provided | |||||
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 | 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 | 0..1 | SimpleQuantity | 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 | |||||
udi | 0..* | Reference(Device) | Unique device identifier | |||||
total | 0..1 | Money | Total claim cost | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
Claim.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Claim.status | required | FinancialResourceStatusCodeshttp://hl7.org/fhir/ValueSet/fm-status|4.0.1 from the FHIR Standard | ||||
Claim.type | extensible | BfsMedstats20Encounterclasshttp://fhir.ch/ig/ch-core/ValueSet/bfs-medstats-20-encounterclass | ||||
Claim.subType | example | ExampleClaimSubTypeCodeshttp://hl7.org/fhir/ValueSet/claim-subtype from the FHIR Standard | ||||
Claim.use | required | Usehttp://hl7.org/fhir/ValueSet/claim-use|4.0.1 from the FHIR Standard | ||||
Claim.priority | example | ProcessPriorityCodeshttp://hl7.org/fhir/ValueSet/process-priority from the FHIR Standard | ||||
Claim.fundsReserve | example | Funds Reservation Codeshttp://hl7.org/fhir/ValueSet/fundsreserve from the FHIR Standard | ||||
Claim.related.relationship | example | ExampleRelatedClaimRelationshipCodeshttp://hl7.org/fhir/ValueSet/related-claim-relationship from the FHIR Standard | ||||
Claim.payee.type | example | Claim Payee Type Codeshttp://hl7.org/fhir/ValueSet/payeetype from the FHIR Standard | ||||
Claim.careTeam.role | example | ClaimCareTeamRoleCodeshttp://hl7.org/fhir/ValueSet/claim-careteamrole from the FHIR Standard | ||||
Claim.careTeam.qualification | example | ExampleProviderQualificationCodeshttp://hl7.org/fhir/ValueSet/provider-qualification from the FHIR Standard | ||||
Claim.supportingInfo.category | example | ClaimInformationCategoryCodeshttp://hl7.org/fhir/ValueSet/claim-informationcategory from the FHIR Standard | ||||
Claim.supportingInfo.code | example | ExceptionCodeshttp://hl7.org/fhir/ValueSet/claim-exception from the FHIR Standard | ||||
Claim.supportingInfo.reason | example | MissingToothReasonCodeshttp://hl7.org/fhir/ValueSet/missing-tooth-reason from the FHIR Standard | ||||
Claim.supportingInfo:treatmentReason.category | example | Pattern: patientreasonforvisithttp://hl7.org/fhir/ValueSet/claim-informationcategory from the FHIR Standard | ||||
Claim.supportingInfo:treatmentReason.code | preferred | TreatmentReasonhttp://fhir.ch/ig/ch-term/ValueSet/treatmentreason | ||||
Claim.supportingInfo:treatmentReason.reason | example | MissingToothReasonCodeshttp://hl7.org/fhir/ValueSet/missing-tooth-reason from the FHIR Standard | ||||
Claim.supportingInfo:remark.category | example | Pattern: infohttp://hl7.org/fhir/ValueSet/claim-informationcategory from the FHIR Standard | ||||
Claim.supportingInfo:remark.code | example | ExceptionCodeshttp://hl7.org/fhir/ValueSet/claim-exception from the FHIR Standard | ||||
Claim.supportingInfo:remark.reason | example | MissingToothReasonCodeshttp://hl7.org/fhir/ValueSet/missing-tooth-reason from the FHIR Standard | ||||
Claim.diagnosis.diagnosis[x] | example | ICD-10Codeshttp://hl7.org/fhir/ValueSet/icd-10 from the FHIR Standard | ||||
Claim.diagnosis.type | example | ExampleDiagnosisTypeCodeshttp://hl7.org/fhir/ValueSet/ex-diagnosistype from the FHIR Standard | ||||
Claim.diagnosis.onAdmission | example | ExampleDiagnosisOnAdmissionCodeshttp://hl7.org/fhir/ValueSet/ex-diagnosis-on-admission from the FHIR Standard | ||||
Claim.diagnosis.packageCode | example | ExampleDiagnosisRelatedGroupCodeshttp://hl7.org/fhir/ValueSet/ex-diagnosisrelatedgroup from the FHIR Standard | ||||
Claim.procedure.type | example | ExampleProcedureTypeCodeshttp://hl7.org/fhir/ValueSet/ex-procedure-type from the FHIR Standard | ||||
Claim.procedure.procedure[x] | example | ICD-10ProcedureCodeshttp://hl7.org/fhir/ValueSet/icd-10-procedures from the FHIR Standard | ||||
Claim.accident.type | extensible | ActIncidentCodehttp://terminology.hl7.org/ValueSet/v3-ActIncidentCode | ||||
Claim.item.revenue | example | ExampleRevenueCenterCodeshttp://hl7.org/fhir/ValueSet/ex-revenue-center from the FHIR Standard | ||||
Claim.item.category | example | BenefitCategoryCodeshttp://hl7.org/fhir/ValueSet/ex-benefitcategory from the FHIR Standard | ||||
Claim.item.productOrService | example | USCLSCodeshttp://hl7.org/fhir/ValueSet/service-uscls from the FHIR Standard | ||||
Claim.item.modifier | example | ModifierTypeCodeshttp://hl7.org/fhir/ValueSet/claim-modifiers from the FHIR Standard | ||||
Claim.item.programCode | example | ExampleProgramReasonCodeshttp://hl7.org/fhir/ValueSet/ex-program-code from the FHIR Standard | ||||
Claim.item.location[x] | example | ExampleServicePlaceCodeshttp://hl7.org/fhir/ValueSet/service-place from the FHIR Standard | ||||
Claim.item.bodySite | example | OralSiteCodeshttp://hl7.org/fhir/ValueSet/tooth from the FHIR Standard | ||||
Claim.item.subSite | example | SurfaceCodeshttp://hl7.org/fhir/ValueSet/surface from the FHIR Standard | ||||
Claim.item.detail.revenue | example | ExampleRevenueCenterCodeshttp://hl7.org/fhir/ValueSet/ex-revenue-center from the FHIR Standard | ||||
Claim.item.detail.category | example | BenefitCategoryCodeshttp://hl7.org/fhir/ValueSet/ex-benefitcategory from the FHIR Standard | ||||
Claim.item.detail.productOrService | example | USCLSCodeshttp://hl7.org/fhir/ValueSet/service-uscls from the FHIR Standard | ||||
Claim.item.detail.modifier | example | ModifierTypeCodeshttp://hl7.org/fhir/ValueSet/claim-modifiers from the FHIR Standard | ||||
Claim.item.detail.programCode | example | ExampleProgramReasonCodeshttp://hl7.org/fhir/ValueSet/ex-program-code from the FHIR Standard | ||||
Claim.item.detail.subDetail.revenue | example | ExampleRevenueCenterCodeshttp://hl7.org/fhir/ValueSet/ex-revenue-center from the FHIR Standard | ||||
Claim.item.detail.subDetail.category | example | BenefitCategoryCodeshttp://hl7.org/fhir/ValueSet/ex-benefitcategory from the FHIR Standard | ||||
Claim.item.detail.subDetail.productOrService | example | USCLSCodeshttp://hl7.org/fhir/ValueSet/service-uscls from the FHIR Standard | ||||
Claim.item.detail.subDetail.modifier | example | ModifierTypeCodeshttp://hl7.org/fhir/ValueSet/claim-modifiers from the FHIR Standard | ||||
Claim.item.detail.subDetail.programCode | example | ExampleProgramReasonCodeshttp://hl7.org/fhir/ValueSet/ex-program-code from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Claim | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Claim | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Claim | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Claim | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Claim | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Claim
Summary
Mandatory: 0 element(6 nested mandatory elements)
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron