Claim
A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reimbursement.
http://hl7.org/fhir/R4/claim.html
Endpoints
Claim create
Create a Claim resource.
Attributes
The FHIR Resource name.
Canvas supports a current queue extension representing the current queue the given claim is in on the Canvas instance. Learn more about navigating claim queues here.
Canvas Built-in Claim Queues
| display | code |
|---|---|
| Adjudicated | AdjudicatedOpenBalance |
| Appointment | Appointment |
| Clinician | NeedsClinicianReview |
| Coding | NeedsCodingReview |
| Filed | FiledAwaitingResponse |
| History | ZeroBalance |
| Patient | PatientBalance |
| Rejected | RejectedNeedsReview |
| Submission | QueuedForSubmission |
| Trash | Trash |
It is possible to create custom queues in Canvas and utilize in the FHIR API.
By default, a claim is created in the NeedsCodingReview queue in Canvas.
Sending a different value in this extension updates the claim to be in that queue.
Reference that defines the content of this object.
Value of extension.
The system url of the coding.
The display name of the coding.
The status of the resource instance.
The category of claim.
Code defined by a terminology system.
The system url of the coding.
The code.
The display name of the coding.
A code to indicate the nature of the request.
The Canvas patient resource for the claim.
The reference string of the subject in the format of "Patient/a39cafb9d1b445be95a2e2548e12a787".
Type the reference refers to (e.g. “Patient”).
The date this resource was created. If only a date is specified, it will default to midnight UTC. If a timezone is not supplied, it will default to use UTC.
This maps to the date of service for note in Canvas the claims is associated with.
Party responsible for the claim. This will be a reference to a Practitioner.
The reference string of the subject in the format of "Practitioner/bb24f084e1fa46c7931663259540266d".
Type the reference refers to (e.g. “Practitioner”).
The provider-required urgency of processing the request.
Code defined by a terminology system.
The system url of the coding.
The code.
The display name of the coding.
Additional information about the Claim.
Canvas supports a single iteration for a reason for visit - the text in the valueString will be the note’s RFV the claim is associated with.
Information instance identifier. Most likely will be 1 since Canvas currently only accepts one SupportingInfo object.
Classification of the supplied information.
The system url of the coding.
The code.
The display name of the coding.
Data to be provided.
Canvas supports free text to be passed as the reason for visit associated with the claim.
Information about diagnoses relevant to the claim items.
These diagnoses will create Assessments in Canvas. At least one diagnosis element is required.
Diagnosis instance identifier.
The sequence should be unique within the Claim message, usually starting at 1 and incrementing as needed.
Nature of illness or problem.
The system url of the coding.
The ICD10 code. Canvas will automatically add the . when displaying in the UI (e.g the code ‘H9190’ is for the ICD10 H91.90 for unspecified hearing loss in an unspecified ear)
The display name of the coding.
Patient insurance information. Contains the list of coverage’s associated with the claim in Canvas.
If the claim should be a self paying claim, pass the insurance list as
"insurance": [
{
"sequence": 1,
"focal": false,
"coverage": {
"display": "No Coverage"
}
}
]
Coverage to be used for adjudication.
Canvas will ignore any elements that are set to False.
Insurance instance identifier.
The sequence should be unique within the Claim message, usually starting at 1 and incrementing as needed.
Insurance Information
The reference string of the coverage in the format of "Coverage/05274c93-341c-4d23-9e46-718f6743609f".
A display of "No Coverage" are for claims that are self pay.
List of service charges to be used in the claim.
Item instance identifier.
The sequence should be unique within the Claim message, usually starting at 1 and incrementing as needed.
Applicable diagnoses. This list of integers corresponds one or more diagnoses in the Claim.diagnosis list that this service charge is associated with.
Billing, service, product, or drug code.
Code defined by a terminology system.
The system url of the coding.
The code.
The display name of the coding.
Count of products or services.
Numerical value.
Fee, charge or cost per item.
Numerical value (with implicit precision)
Product or service billing modifiers.
Code defined by a terminology system.
The system url of the coding.
The code.
The display name of the coding.
Responses
Canvas returns the created resource's id as a UUID within the
location header and a null response body.Errors
Claim read
Read a Claim resource.
Path Parameters
Response Payload Attributes
The FHIR Resource name.
The identifier of the Claim.
Canvas supports a current queue extension representing the current queue the given claim is in on the Canvas instance. Learn more about navigating claim queues here.
Canvas Built-in Claim Queues
| display | code |
|---|---|
| Adjudicated | AdjudicatedOpenBalance |
| Appointment | Appointment |
| Clinician | NeedsClinicianReview |
| Coding | NeedsCodingReview |
| Filed | FiledAwaitingResponse |
| History | ZeroBalance |
| Patient | PatientBalance |
| Rejected | RejectedNeedsReview |
| Submission | QueuedForSubmission |
| Trash | Trash |
It is possible to create custom queues in Canvas and utilize in the FHIR API.
Canvas supports a note identifier extension on this resource. The note identifier can be used with the Canvas Note API
Reference that defines the content of this object.
Value of extension.
The system url of the coding.
The display name of the coding.
The valueId field is used for the Note extension and will be the note’s unique identifier.
The status of the resource instance.
The category of claim.
Code defined by a terminology system.
The system url of the coding.
The code.
The display name of the coding.
A code to indicate the nature of the request.
The Canvas patient resource for the claim.
The reference string of the subject in the format of "Patient/a39cafb9d1b445be95a2e2548e12a787".
Type the reference refers to (e.g. “Patient”).
The date this resource was created. If only a date is specified, it will default to midnight UTC. If a timezone is not supplied, it will default to use UTC.
This maps to the date of service for note in Canvas the claims is associated with.
Party responsible for the claim. This will be a reference to a Practitioner.
The reference string of the subject in the format of "Practitioner/bb24f084e1fa46c7931663259540266d".
Type the reference refers to (e.g. “Practitioner”).
The provider-required urgency of processing the request.
Code defined by a terminology system.
The system url of the coding.
The code.
The display name of the coding.
Additional information about the Claim.
Canvas supports a single iteration for a reason for visit - the text in the valueString will be the note’s RFV the claim is associated with.
Information instance identifier. Most likely will be 1 since Canvas currently only accepts one SupportingInfo object.
Classification of the supplied information.
The system url of the coding.
The code.
The display name of the coding.
Data to be provided.
Canvas supports free text to be passed as the reason for visit associated with the claim.
Information about diagnoses relevant to the claim items.
Diagnosis instance identifier.
The sequence should be unique within the Claim message, usually starting at 1 and incrementing as needed.
Nature of illness or problem.
The system url of the coding.
The ICD10 code. Canvas will automatically add the . when displaying in the UI (e.g the code ‘H9190’ is for the ICD10 H91.90 for unspecified hearing loss in an unspecified ear)
The display name of the coding.
Patient insurance information. Contains the list of coverage’s associated with the claim in Canvas.
Coverage to be used for adjudication.
Only insurance objects with focal as True will be returned in a Search/Read.
Insurance instance identifier.
The sequence should be unique within the Claim message, usually starting at 1 and incrementing as needed.
Insurance Information
The reference string of the coverage in the format of "Coverage/05274c93-341c-4d23-9e46-718f6743609f".
A display of "No Coverage" are for claims that are self pay.
List of service charges to be used in the claim.
Item instance identifier.
The sequence should be unique within the Claim message, usually starting at 1 and incrementing as needed.
Applicable diagnoses. This list of integers corresponds one or more diagnoses in the Claim.diagnosis list that this service charge is associated with.
Billing, service, product, or drug code.
Code defined by a terminology system.
The system url of the coding.
The code.
The display name of the coding.
Count of products or services.
Numerical value.
Fee, charge or cost per item.
Numerical value (with implicit precision)
Encounters related to this billed item.
The reference string of the encounter in the format of "Encounter/879b35fd-3bc2-4ccd-98d7-954dd9b6d0a9".
Type the reference refers to (e.g. “Encounter”).
Product or service billing modifiers.
Code defined by a terminology system.
The system url of the coding.
The code.
The display name of the coding.
Responses
Errors
Claim update
Update a Claim resource.
The only Claim update supported by Canvas is to change an existing Claim’s queue. Changes to other fields will be ignored, but required fields must still be valued.
Attributes
The FHIR Resource name.
The identifier of the Claim.
Canvas supports a current queue extension representing the current queue the given claim is in on the Canvas instance. Learn more about navigating claim queues here.
Canvas Built-in Claim Queues
| display | code |
|---|---|
| Adjudicated | AdjudicatedOpenBalance |
| Appointment | Appointment |
| Clinician | NeedsClinicianReview |
| Coding | NeedsCodingReview |
| Filed | FiledAwaitingResponse |
| History | ZeroBalance |
| Patient | PatientBalance |
| Rejected | RejectedNeedsReview |
| Submission | QueuedForSubmission |
| Trash | Trash |
It is possible to create custom queues in Canvas and utilize in the FHIR API.
By default, a claim is created in the NeedsCodingReview queue in Canvas.
Sending a different value in this extension updates the claim to be in that queue.
Reference that defines the content of this object.
Value of extension.
The system url of the coding.
The display name of the coding.
The status of the resource instance.
The category of claim.
Code defined by a terminology system.
The system url of the coding.
The code.
The display name of the coding.
A code to indicate the nature of the request.
The Canvas patient resource for the claim.
The reference string of the subject in the format of "Patient/a39cafb9d1b445be95a2e2548e12a787".
Type the reference refers to (e.g. “Patient”).
The date this resource was created. If only a date is specified, it will default to midnight UTC. If a timezone is not supplied, it will default to use UTC.
This maps to the date of service for note in Canvas the claims is associated with.
Party responsible for the claim. This will be a reference to a Practitioner.
The reference string of the subject in the format of "Practitioner/bb24f084e1fa46c7931663259540266d".
Type the reference refers to (e.g. “Practitioner”).
The provider-required urgency of processing the request.
Code defined by a terminology system.
The system url of the coding.
The code.
The display name of the coding.
Additional information about the Claim.
Canvas supports a single iteration for a reason for visit - the text in the valueString will be the note’s RFV the claim is associated with.
Information instance identifier. Most likely will be 1 since Canvas currently only accepts one SupportingInfo object.
Classification of the supplied information.
The system url of the coding.
The code.
The display name of the coding.
Data to be provided.
Canvas supports free text to be passed as the reason for visit associated with the claim.
Information about diagnoses relevant to the claim items.
These diagnoses will create Assessments in Canvas. At least one diagnosis element is required.
Diagnosis instance identifier.
The sequence should be unique within the Claim message, usually starting at 1 and incrementing as needed.
Nature of illness or problem.
The system url of the coding.
The ICD10 code. Canvas will automatically add the . when displaying in the UI (e.g the code ‘H9190’ is for the ICD10 H91.90 for unspecified hearing loss in an unspecified ear)
The display name of the coding.
Patient insurance information. Contains the list of coverage’s associated with the claim in Canvas.
If the claim should be a self paying claim, pass the insurance list as
"insurance": [
{
"sequence": 1,
"focal": false,
"coverage": {
"display": "No Coverage"
}
}
]
Coverage to be used for adjudication.
Canvas will ignore any elements that are set to False.
Insurance instance identifier.
The sequence should be unique within the Claim message, usually starting at 1 and incrementing as needed.
Insurance Information
The reference string of the coverage in the format of "Coverage/05274c93-341c-4d23-9e46-718f6743609f".
A display of "No Coverage" are for claims that are self pay.
List of service charges to be used in the claim.
Item instance identifier.
The sequence should be unique within the Claim message, usually starting at 1 and incrementing as needed.
Applicable diagnoses. This list of integers corresponds one or more diagnoses in the Claim.diagnosis list that this service charge is associated with.
Billing, service, product, or drug code.
Code defined by a terminology system.
The system url of the coding.
The code.
The display name of the coding.
Count of products or services.
Numerical value.
Fee, charge or cost per item.
Numerical value (with implicit precision)
Product or service billing modifiers.
Code defined by a terminology system.
The system url of the coding.
The code.
The display name of the coding.
Responses
Canvas returns a
null response body.Errors
Claim search
Search for Claim resources.
Query Parameters
The Canvas resource identifier of the Claim
The patient reference associated to the Claim in the format Patient/a39cafb9d1b445be95a2e2548e12a787.
Response Payload Attributes
The FHIR Resource name.
This element and value designate that the bundle is a search response. Search result bundles will always have the Bundle.type of searchset .
The number of resources that match the search parameter.
Attributes relevant to pagination, see our Pagination page for more detail.
The relation of the page search
The search url for the specific relation
The results bundle that lists out each object returned in the search
The attributes specific to the resource type, see the Attributes section below
Attributes
The FHIR Resource name.
The identifier of the Claim.
Canvas supports a current queue extension representing the current queue the given claim is in on the Canvas instance. Learn more about navigating claim queues here.
Canvas Built-in Claim Queues
| display | code |
|---|---|
| Adjudicated | AdjudicatedOpenBalance |
| Appointment | Appointment |
| Clinician | NeedsClinicianReview |
| Coding | NeedsCodingReview |
| Filed | FiledAwaitingResponse |
| History | ZeroBalance |
| Patient | PatientBalance |
| Rejected | RejectedNeedsReview |
| Submission | QueuedForSubmission |
| Trash | Trash |
It is possible to create custom queues in Canvas and utilize in the FHIR API.
Canvas supports a note identifier extension on this resource. The note identifier can be used with the Canvas Note API
Reference that defines the content of this object.
Value of extension.
The system url of the coding.
The display name of the coding.
The valueId field is used for the Note extension and will be the note’s unique identifier.
The status of the resource instance.
The category of claim.
Code defined by a terminology system.
The system url of the coding.
The code.
The display name of the coding.
A code to indicate the nature of the request.
The Canvas patient resource for the claim.
The reference string of the subject in the format of "Patient/a39cafb9d1b445be95a2e2548e12a787".
Type the reference refers to (e.g. “Patient”).
The date this resource was created. If only a date is specified, it will default to midnight UTC. If a timezone is not supplied, it will default to use UTC.
This maps to the date of service for note in Canvas the claims is associated with.
Party responsible for the claim. This will be a reference to a Practitioner.
The reference string of the subject in the format of "Practitioner/bb24f084e1fa46c7931663259540266d".
Type the reference refers to (e.g. “Practitioner”).
The provider-required urgency of processing the request.
Code defined by a terminology system.
The system url of the coding.
The code.
The display name of the coding.
Additional information about the Claim.
Canvas supports a single iteration for a reason for visit - the text in the valueString will be the note’s RFV the claim is associated with.
Information instance identifier. Most likely will be 1 since Canvas currently only accepts one SupportingInfo object.
Classification of the supplied information.
The system url of the coding.
The code.
The display name of the coding.
Data to be provided.
Canvas supports free text to be passed as the reason for visit associated with the claim.
Information about diagnoses relevant to the claim items.
Diagnosis instance identifier.
The sequence should be unique within the Claim message, usually starting at 1 and incrementing as needed.
Nature of illness or problem.
The system url of the coding.
The ICD10 code. Canvas will automatically add the . when displaying in the UI (e.g the code ‘H9190’ is for the ICD10 H91.90 for unspecified hearing loss in an unspecified ear)
The display name of the coding.
Patient insurance information. Contains the list of coverage’s associated with the claim in Canvas.
Coverage to be used for adjudication.
Only insurance objects with focal as True will be returned in a Search/Read.
Insurance instance identifier.
The sequence should be unique within the Claim message, usually starting at 1 and incrementing as needed.
Insurance Information
The reference string of the coverage in the format of "Coverage/05274c93-341c-4d23-9e46-718f6743609f".
A display of "No Coverage" are for claims that are self pay.
List of service charges to be used in the claim.
Item instance identifier.
The sequence should be unique within the Claim message, usually starting at 1 and incrementing as needed.
Applicable diagnoses. This list of integers corresponds one or more diagnoses in the Claim.diagnosis list that this service charge is associated with.
Billing, service, product, or drug code.
Code defined by a terminology system.
The system url of the coding.
The code.
The display name of the coding.
Count of products or services.
Numerical value.
Fee, charge or cost per item.
Numerical value (with implicit precision)
Encounters related to this billed item.
The reference string of the encounter in the format of "Encounter/879b35fd-3bc2-4ccd-98d7-954dd9b6d0a9".
Type the reference refers to (e.g. “Encounter”).
Product or service billing modifiers.
Code defined by a terminology system.
The system url of the coding.
The code.
The display name of the coding.
Responses
Errors
curl --request POST \ --url 'https://fumage-example.canvasmedical.com/Claim' \ --header 'Authorization: Bearer <token>' \ --header 'accept: application/json' \ --header 'content-type: application/json' \ --data ' { "resourceType": "Claim", "extension": [ { "url": "http://schemas.canvasmedical.com/fhir/extensions/claim-queue", "valueCoding": { "system": "http://canvasmedical.com", "code": "NeedsClinicianReview", "display": "Clinician" } } ], "status": "active", "type": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/claim-type", "code": "professional" } ] }, "use": "claim", "patient": { "reference": "Patient/b3084f7e884e4af2b7e23b1dca494abd", "type": "Patient" }, "created": "2021-08-16", "provider": { "reference": "Practitioner/4150cd20de8a470aa570a852859ac87e", "type": "Practitioner" }, "priority": { "coding": [ { "code": "normal", "system": "http://terminology.hl7.org/CodeSystem/processpriority" } ] }, "supportingInfo": [ { "sequence": 1, "category": { "coding": [ { "code": "patientreasonforvisit", "system": "http://terminology.hl7.org/CodeSystem/claiminformationcategory", "display": "Patient Reason for Visit" } ] }, "valueString": "This is only...a test" } ], "diagnosis": [ { "sequence": 1, "diagnosisCodeableConcept": { "coding": [ { "code": "F41.1", "system": "http://hl7.org/fhir/sid/icd-10-cm", "display": "Generalized anxiety" } ] } } ], "insurance": [ { "sequence": 1, "focal": true, "coverage": { "reference": "Coverage/02d4f77a-ebaf-47d5-b162-6313244aed5f" } } ], "item": [ { "sequence": 1, "diagnosisSequence": [ 1 ], "productOrService": { "coding": [ { "system": "http://www.ama-assn.org/go/cpt", "code": "exam", "display": "Office visit" } ] }, "modifier": [ { "coding": [ { "system": "https://www.cms.gov/Medicare/Coding/HCPCSReleaseCodeSets", "code": "21" } ] } ], "quantity": { "value": 1 }, "unitPrice": { "value": 75 } } ] }'import requests url = "https://fumage-example.canvasmedical.com/Claim" headers = { "accept": "application/json", "Authorization": "Bearer <token>", "content-type": "application/json" } payload = { "resourceType": "Claim", "extension": [ { "url": "http://schemas.canvasmedical.com/fhir/extensions/claim-queue", "valueCoding": { "system": "http://canvasmedical.com", "code": "NeedsClinicianReview", "display": "Clinician" } } ], "status": "active", "type": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/claim-type", "code": "professional" } ] }, "use": "claim", "patient": { "reference": "Patient/b3084f7e884e4af2b7e23b1dca494abd", "type": "Patient" }, "created": "2021-08-16", "provider": { "reference": "Practitioner/4150cd20de8a470aa570a852859ac87e", "type": "Practitioner" }, "priority": { "coding": [ { "code": "normal", "system": "http://terminology.hl7.org/CodeSystem/processpriority" } ] }, "supportingInfo": [ { "sequence": 1, "category": { "coding": [ { "code": "patientreasonforvisit", "system": "http://terminology.hl7.org/CodeSystem/claiminformationcategory", "display": "Patient Reason for Visit" } ] }, "valueString": "This is only...a test" } ], "diagnosis": [ { "sequence": 1, "diagnosisCodeableConcept": { "coding": [ { "code": "F41.1", "system": "http://hl7.org/fhir/sid/icd-10-cm", "display": "Generalized anxiety" } ] } } ], "insurance": [ { "sequence": 1, "focal": True, "coverage": { "reference": "Coverage/02d4f77a-ebaf-47d5-b162-6313244aed5f" } } ], "item": [ { "sequence": 1, "diagnosisSequence": [ 1 ], "productOrService": { "coding": [ { "system": "http://www.ama-assn.org/go/cpt", "code": "exam", "display": "Office visit" } ] }, "modifier": [ { "coding": [ { "system": "https://www.cms.gov/Medicare/Coding/HCPCSReleaseCodeSets", "code": "21" } ] } ], "quantity": { "value": 1 }, "unitPrice": { "value": 75 } } ] } response = requests.post(url, json=payload, headers=headers) print(response.text)
null{ "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "invalid", "details": { "text": "Bad request" } } ] }{ "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "unknown", "details": { "text": "Authentication failed" } } ] }{ "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "forbidden", "details": { "text": "Authorization failed" } } ] }{ "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "not-supported", "details": { "text": "Operation is not supported" } } ] }{ "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "business-rule", "details": { "text": "Unprocessable entity" } } ] }
curl --request GET \ --url 'https://fumage-example.canvasmedical.com/Claim/<id>' \ --header 'Authorization: Bearer <token>' \ --header 'accept: application/json'import requests url = "https://fumage-example.canvasmedical.com/Claim/<id>" headers = { "accept": "application/json", "Authorization": "Bearer <token>" } response = requests.get(url, headers=headers) print(response.text)
{ "resourceType": "Claim", "id": "e4df0a15-d98c-400e-ad46-54eeb13f2753", "extension": [ { "url": "http://schemas.canvasmedical.com/fhir/extensions/claim-queue", "valueCoding": { "system": "http://canvasmedical.com", "code": "NeedsClinicianReview", "display": "Clinician" } } ], "status": "active", "type": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/claim-type", "code": "professional" } ] }, "use": "claim", "patient": { "reference": "Patient/4dc9d97b71924de58b54a9a91a8250dd", "type": "Patient" }, "created": "2023-11-16", "provider": { "reference": "Practitioner/4150cd20de8a470aa570a852859ac87e", "type": "Practitioner" }, "priority": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/processpriority", "code": "normal" } ] }, "diagnosis": [ { "sequence": 1, "diagnosisCodeableConcept": { "coding": [ { "system": "http://hl7.org/fhir/sid/icd-10-cm", "code": "J940", "display": "Chylous effusion" } ] } }, { "sequence": 2, "diagnosisCodeableConcept": { "coding": [ { "system": "http://hl7.org/fhir/sid/icd-10-cm", "code": "L639", "display": "Alopecia areata, unspecified" } ] } } ], "insurance": [ { "sequence": 1, "focal": true, "coverage": { "reference": "Coverage/39f37e33-bb0b-4e6b-88ca-56ea94629974", "type": "Coverage" } } ], "item": [ { "sequence": 1, "diagnosisSequence": [ 1, 2 ], "productOrService": { "coding": [ { "system": "http://www.ama-assn.org/go/cpt", "code": "99211", "display": "Office outpatient visit 5 minutes" } ] }, "quantity": { "value": 1 }, "unitPrice": { "value": 50.0 }, "net": { "value": 50.0 } }, { "sequence": 2, "diagnosisSequence": [ 1 ], "productOrService": { "coding": [ { "system": "http://www.ama-assn.org/go/cpt", "code": "77012", "display": "Ct guidance needle placement" } ] }, "quantity": { "value": 1 }, "unitPrice": { "value": 200.0 }, "net": { "value": 200.0 } } ] }{ "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "unknown", "details": { "text": "Authentication failed" } } ] }{ "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "forbidden", "details": { "text": "Authorization failed" } } ] }{ "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "not-found", "details": { "text": "Unknown Claim resource 'a47c7b0ebbb442cdbc4adf259d148ea1'" } } ] }
curl --request PUT \ --url 'https://fumage-example.canvasmedical.com/Claim/<id>' \ --header 'Authorization: Bearer <token>' \ --header 'accept: application/json' \ --header 'content-type: application/json' \ --data ' { "resourceType": "Claim", "extension": [ { "url": "http://schemas.canvasmedical.com/fhir/extensions/claim-queue", "valueCoding": { "system": "http://canvasmedical.com", "code": "AdjudicatedOpenBalance", "display": "Adjudicated" } } ], "status": "active", "type": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/claim-type", "code": "professional" } ] }, "use": "claim", "patient": { "reference": "Patient/b3084f7e884e4af2b7e23b1dca494abd", "type": "Patient" }, "created": "2021-08-16", "provider": { "reference": "Practitioner/4150cd20de8a470aa570a852859ac87e", "type": "Practitioner" }, "priority": { "coding": [ { "code": "normal", "system": "http://terminology.hl7.org/CodeSystem/processpriority" } ] }, "supportingInfo": [ { "sequence": 1, "category": { "coding": [ { "code": "patientreasonforvisit", "system": "http://terminology.hl7.org/CodeSystem/claiminformationcategory", "display": "Patient Reason for Visit" } ] }, "valueString": "This is only...a test" } ], "diagnosis": [ { "sequence": 1, "diagnosisCodeableConcept": { "coding": [ { "code": "F41.1", "system": "http://hl7.org/fhir/sid/icd-10-cm", "display": "Generalized anxiety" } ] } } ], "insurance": [ { "sequence": 1, "focal": true, "coverage": { "reference": "Coverage/02d4f77a-ebaf-47d5-b162-6313244aed5f" } } ], "item": [ { "sequence": 1, "diagnosisSequence": [ 1 ], "productOrService": { "coding": [ { "system": "http://www.ama-assn.org/go/cpt", "code": "exam", "display": "Office visit" } ] }, "modifier": [ { "coding": [ { "system": "https://www.cms.gov/Medicare/Coding/HCPCSReleaseCodeSets", "code": "21" } ] } ], "quantity": { "value": 1 }, "unitPrice": { "value": 75 } } ] }'import requests url = "https://fumage-example.canvasmedical.com/Claim/<id>" headers = { "accept": "application/json", "Authorization": "Bearer <token>", "content-type": "application/json" } payload = { "resourceType": "Claim", "extension": [ { "url": "http://schemas.canvasmedical.com/fhir/extensions/claim-queue", "valueCoding": { "system": "http://canvasmedical.com", "code": "AdjudicatedOpenBalance", "display": "Adjudicated" } } ], "status": "active", "type": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/claim-type", "code": "professional" } ] }, "use": "claim", "patient": { "reference": "Patient/b3084f7e884e4af2b7e23b1dca494abd", "type": "Patient" }, "created": "2021-08-16", "provider": { "reference": "Practitioner/4150cd20de8a470aa570a852859ac87e", "type": "Practitioner" }, "priority": { "coding": [ { "code": "normal", "system": "http://terminology.hl7.org/CodeSystem/processpriority" } ] }, "supportingInfo": [ { "sequence": 1, "category": { "coding": [ { "code": "patientreasonforvisit", "system": "http://terminology.hl7.org/CodeSystem/claiminformationcategory", "display": "Patient Reason for Visit" } ] }, "valueString": "This is only...a test" } ], "diagnosis": [ { "sequence": 1, "diagnosisCodeableConcept": { "coding": [ { "code": "F41.1", "system": "http://hl7.org/fhir/sid/icd-10-cm", "display": "Generalized anxiety" } ] } } ], "insurance": [ { "sequence": 1, "focal": True, "coverage": { "reference": "Coverage/02d4f77a-ebaf-47d5-b162-6313244aed5f" } } ], "item": [ { "sequence": 1, "diagnosisSequence": [ 1 ], "productOrService": { "coding": [ { "system": "http://www.ama-assn.org/go/cpt", "code": "exam", "display": "Office visit" } ] }, "modifier": [ { "coding": [ { "system": "https://www.cms.gov/Medicare/Coding/HCPCSReleaseCodeSets", "code": "21" } ] } ], "quantity": { "value": 1 }, "unitPrice": { "value": 75 } } ] } response = requests.put(url, json=payload, headers=headers) print(response.text)
null{ "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "invalid", "details": { "text": "Bad request" } } ] }{ "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "unknown", "details": { "text": "Authentication failed" } } ] }{ "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "forbidden", "details": { "text": "Authorization failed" } } ] }{ "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "not-found", "details": { "text": "Unknown Claim resource 'a47c7b0e-bbb4-42cd-bc4a-df259d148ea1'" } } ] }{ "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "not-supported", "details": { "text": "Operation is not supported" } } ] }{ "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "conflict", "details": { "text": "Resource updated since If-Unmodified-Since date" } } ] }{ "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "business-rule", "details": { "text": "Unprocessable entity" } } ] }
curl --request GET \ --url 'https://fumage-example.canvasmedical.com/Claim?patient=Patient/4dc9d97b71924de58b54a9a91a8250dd' \ --header 'Authorization: Bearer <token>' \ --header 'accept: application/json'import requests url = "https://fumage-example.canvasmedical.com/Claim?patient=Patient/4dc9d97b71924de58b54a9a91a8250dd" headers = { "accept": "application/json", "Authorization": "Bearer <token>" } response = requests.get(url, headers=headers) print(response.text)
{ "resourceType": "Bundle", "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "/Claim?patient=4dc9d97b71924de58b54a9a91a8250dd&_count=10&_offset=0" }, { "relation": "first", "url": "/Claim?patient=4dc9d97b71924de58b54a9a91a8250dd&_count=10&_offset=0" }, { "relation": "last", "url": "/Claim?patient=4dc9d97b71924de58b54a9a91a8250dd&_count=10&_offset=0" } ], "entry": [ { "resource": { "resourceType": "Claim", "id": "e4df0a15-d98c-400e-ad46-54eeb13f2753", "extension": [ { "url": "http://schemas.canvasmedical.com/fhir/extensions/claim-queue", "valueCoding": { "system": "http://canvasmedical.com", "code": "AdjudicatedOpenBalance", "display": "Adjudicated" } } ], "status": "active", "type": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/claim-type", "code": "professional" } ] }, "use": "claim", "patient": { "reference": "Patient/4dc9d97b71924de58b54a9a91a8250dd", "type": "Patient" }, "created": "2023-11-16", "provider": { "reference": "Practitioner/4150cd20de8a470aa570a852859ac87e", "type": "Practitioner" }, "priority": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/processpriority", "code": "normal" } ] }, "diagnosis": [ { "sequence": 1, "diagnosisCodeableConcept": { "coding": [ { "system": "http://hl7.org/fhir/sid/icd-10-cm", "code": "J940", "display": "Chylous effusion" } ] } }, { "sequence": 2, "diagnosisCodeableConcept": { "coding": [ { "system": "http://hl7.org/fhir/sid/icd-10-cm", "code": "L639", "display": "Alopecia areata, unspecified" } ] } } ], "insurance": [ { "sequence": 1, "focal": true, "coverage": { "reference": "Coverage/39f37e33-bb0b-4e6b-88ca-56ea94629974", "type": "Coverage" } } ], "item": [ { "sequence": 1, "diagnosisSequence": [ 1, 2 ], "productOrService": { "coding": [ { "system": "http://www.ama-assn.org/go/cpt", "code": "99211", "display": "Office outpatient visit 5 minutes" } ] }, "quantity": { "value": 1 }, "unitPrice": { "value": 50.0 }, "net": { "value": 50.0 } }, { "sequence": 2, "diagnosisSequence": [ 1 ], "productOrService": { "coding": [ { "system": "http://www.ama-assn.org/go/cpt", "code": "77012", "display": "Ct guidance needle placement" } ] }, "quantity": { "value": 1 }, "unitPrice": { "value": 200.0 }, "net": { "value": 200.0 } } ] } } ] }{ "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "unknown", "details": { "text": "Authentication failed" } } ] }{ "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "forbidden", "details": { "text": "Authorization failed" } } ] }