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

post
/Claim

Claim create

Create a Claim resource.

Attributes

extension
array[json]

Canvas supports a single extension iteration on a claim.

By default, a claim is created in the NeedsCodingReview queue in Canvas.

Sending a different value in this extension creates or updates a claim to be in that queue.

The url must be http://schemas.canvasmedical.com/fhir/extensions/claim-queue and the system must be http://canvasmedical.com

Supported claim queues

displaycode
AdjudicatedAdjudicatedOpenBalance
AppointmentAppointment
ClinicianNeedsClinicianReview
CodingNeedsCodingReview
FiledFiledAwaitingResponse
HistoryZeroBalance
PatientPatientBalance
RejectedRejectedNeedsReview
SubmissionQueuedForSubmission
TrashTrash
status
string required

The status of the resource instance.

Supported codes for create interactions are: active

type
json required

The category of claim.

Supported codes for create interactions are: professional with a system of http://terminology.hl7.org/CodeSystem/claim-type

use
string required

A code to indicate the nature of the request

Supported codes for create interactions are: claim

patient
json required

The Canvas patient resource for the claim

created
date required

The date this resource was created.
Canvas will use this as the date of service for the claims in this message.

Expected format is : YYYY-MM-DD

provider
json required

The Canvas provider resource for the staff responsible for the claim.

priority
json required

The provider-required urgency of processing the request.

Supported codes for create interactions are: normal with a system of http://terminology.hl7.org/CodeSystem/processpriority

supportingInfo
array[json]

Additional information about the Claim

Canvas supports a single iteration for a reason for visit - the text in the valueString will be used.

diagnosis
array[json] required

Information about diagnoses relevant to the claim items.

These diagnoses will create Assessments in Canvas.

The sequence should be unique within the Claim message, usually starting at 1 and incrementing as needed.

Must be a diagnosisCodeableConcept

Codes are supported from the following systems: http://hl7.org/fhir/sid/icd-10-cm

insurance
array[json] required

FHIR resource for the coverage(s) to use when adjudicating the claim

sequence should be unique for each insurance in the claim message.

focal indicates whether this insurance should be used to adjudicate the claim in this message. Canvas will ignore any elements that are False.

coverage is a Canvas coverage resource identifying the coverage for this iteration of insurance

Additional information on a Coverage can be obtained from the Coverage search endpoint

item
array[json] required

List of service charges to be used in the claim.

sequence should be unique for each item in the message.

diagnosisSequence should have one or more sequence values from the diagnosis section.

productOrService is an object that specifies the coding of the service. Canvas uses the first coding where system is http://www.ama-assn.org/go/cpt.

modifier specifies the list of charge modifier codings. Canvas accepts the first element where the coding’s system is https://www.cms.gov/Medicare/Coding/HCPCSReleaseCodeSets. Canvas uses the 2 character modifiers from this CodeSet.

Responses

201 Created
The server has successfully processed the request; the new resource has been created and is now ready for interaction.

Canvas returns the created resource's id as a UUID within the location header and a null response body.

Errors

400 Bad Request
The request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401 Unauthorized
The request requires user authentication.
403 Forbidden
The request requires user authorization.
405 Method Not Allowed
The request performs an operation that is either not supported or allowed.
422 Unprocessable Entity
The request cannot be processed due to semantic issues or conflicts with the database state.
get
/Claim/{id}

Claim read

Read a Claim resource.

Path Parameters

id required
string
The unique identifier for the Claim

Response Payload Attributes

extension
array[json]

Canvas supports a single extension iteration on a claim.

By default, a claim is created in the NeedsCodingReview queue in Canvas.

Sending a different value in this extension creates or updates a claim to be in that queue.

The url must be http://schemas.canvasmedical.com/fhir/extensions/claim-queue and the system must be http://canvasmedical.com

Supported claim queues

displaycode
AdjudicatedAdjudicatedOpenBalance
AppointmentAppointment
ClinicianNeedsClinicianReview
CodingNeedsCodingReview
FiledFiledAwaitingResponse
HistoryZeroBalance
PatientPatientBalance
RejectedRejectedNeedsReview
SubmissionQueuedForSubmission
TrashTrash
status
string

The status of the resource instance.

Supported codes for create interactions are: active

type
json

The category of claim.

Supported codes for create interactions are: professional with a system of http://terminology.hl7.org/CodeSystem/claim-type

use
string

A code to indicate the nature of the request

Supported codes for create interactions are: claim

patient
json

The Canvas patient resource for the claim

created
date

The date this resource was created.
Canvas will use this as the date of service for the claims in this message.

Expected format is : YYYY-MM-DD

provider
json

The Canvas provider resource for the staff responsible for the claim.

priority
json

The provider-required urgency of processing the request.

Supported codes for create interactions are: normal with a system of http://terminology.hl7.org/CodeSystem/processpriority

supportingInfo
array[json]

Additional information about the Claim

Canvas supports a single iteration for a reason for visit - the text in the valueString will be used.

diagnosis
array[json]

Information about diagnoses relevant to the claim items.

These diagnoses will create Assessments in Canvas.

The sequence should be unique within the Claim message, usually starting at 1 and incrementing as needed.

Must be a diagnosisCodeableConcept

Codes are supported from the following systems: http://hl7.org/fhir/sid/icd-10-cm

insurance
array[json]

FHIR resource for the coverage(s) to use when adjudicating the claim

sequence should be unique for each insurance in the claim message.

focal indicates whether this insurance should be used to adjudicate the claim in this message. Canvas will ignore any elements that are False.

coverage is a Canvas coverage resource identifying the coverage for this iteration of insurance

Additional information on a Coverage can be obtained from the Coverage search endpoint

item
array[json]

List of service charges to be used in the claim.

sequence should be unique for each item in the message.

diagnosisSequence should have one or more sequence values from the diagnosis section.

productOrService is an object that specifies the coding of the service. Canvas uses the first coding where system is http://www.ama-assn.org/go/cpt.

modifier specifies the list of charge modifier codings. Canvas accepts the first element where the coding’s system is https://www.cms.gov/Medicare/Coding/HCPCSReleaseCodeSets. Canvas uses the 2 character modifiers from this CodeSet.

Responses

200 OK
Request was successful.

Errors

401 Unauthorized
The request requires user authentication.
403 Forbidden
The request requires user authorization.
404 Not Found
The requested resource was not found.
put
/Claim/{id}

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

extension
array[json]

Canvas supports a single extension iteration on a claim.

By default, a claim is created in the NeedsCodingReview queue in Canvas.

Sending a different value in this extension creates or updates a claim to be in that queue.

The url must be http://schemas.canvasmedical.com/fhir/extensions/claim-queue and the system must be http://canvasmedical.com

Supported claim queues

displaycode
AdjudicatedAdjudicatedOpenBalance
AppointmentAppointment
ClinicianNeedsClinicianReview
CodingNeedsCodingReview
FiledFiledAwaitingResponse
HistoryZeroBalance
PatientPatientBalance
RejectedRejectedNeedsReview
SubmissionQueuedForSubmission
TrashTrash
status
string required

The status of the resource instance.

Supported codes for create interactions are: active

type
json required

The category of claim.

Supported codes for create interactions are: professional with a system of http://terminology.hl7.org/CodeSystem/claim-type

use
string required

A code to indicate the nature of the request

Supported codes for create interactions are: claim

patient
json required

The Canvas patient resource for the claim

created
date required

The date this resource was created.
Canvas will use this as the date of service for the claims in this message.

Expected format is : YYYY-MM-DD

provider
json required

The Canvas provider resource for the staff responsible for the claim.

priority
json required

The provider-required urgency of processing the request.

Supported codes for create interactions are: normal with a system of http://terminology.hl7.org/CodeSystem/processpriority

supportingInfo
array[json]

Additional information about the Claim

Canvas supports a single iteration for a reason for visit - the text in the valueString will be used.

diagnosis
array[json] required

Information about diagnoses relevant to the claim items.

These diagnoses will create Assessments in Canvas.

The sequence should be unique within the Claim message, usually starting at 1 and incrementing as needed.

Must be a diagnosisCodeableConcept

Codes are supported from the following systems: http://hl7.org/fhir/sid/icd-10-cm

insurance
array[json] required

FHIR resource for the coverage(s) to use when adjudicating the claim

sequence should be unique for each insurance in the claim message.

focal indicates whether this insurance should be used to adjudicate the claim in this message. Canvas will ignore any elements that are False.

coverage is a Canvas coverage resource identifying the coverage for this iteration of insurance

Additional information on a Coverage can be obtained from the Coverage search endpoint

item
array[json] required

List of service charges to be used in the claim.

sequence should be unique for each item in the message.

diagnosisSequence should have one or more sequence values from the diagnosis section.

productOrService is an object that specifies the coding of the service. Canvas uses the first coding where system is http://www.ama-assn.org/go/cpt.

modifier specifies the list of charge modifier codings. Canvas accepts the first element where the coding’s system is https://www.cms.gov/Medicare/Coding/HCPCSReleaseCodeSets. Canvas uses the 2 character modifiers from this CodeSet.

Responses

200 OK
The server has successfully processed the request.

Canvas returns a null response body.

Errors

400 Bad Request
The request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401 Unauthorized
The request requires user authentication.
403 Forbidden
The request requires user authorization.
404 Not Found
The requested resource was not found.
405 Method Not Allowed
The request performs an operation that is either not supported or allowed.
412 Precondition Failed
The request depends on a precondition that has not been met.
422 Unprocessable Entity
The request cannot be processed due to semantic issues or conflicts with the database state.

Query Parameters

_id
string

The Canvas resource identifier of the Claim

patient
string

Patient receiving the products or services

Response Payload Attributes

resourceType
string

The FHIR Resource name.

type
string

This element and value designate that the bundle is a search response. Search result bundles will always have the Bundle.type of searchset .

total
integer

The number of resources that match the search parameter.

link
array[json]

Attributes relevant to pagination, see our Pagination page for more detail.

Click to view child attributes
relation
enum [self|first|next|last]

The relation of the page search

url

The search url for the specific relation

entry
array[json]

The results bundle that lists out each object returned in the search

Click to view child attributes
resource
json

The attributes specific to the resource type, see the Attributes section below

Attributes

extension
array[json]

Canvas supports a single extension iteration on a claim.

By default, a claim is created in the NeedsCodingReview queue in Canvas.

Sending a different value in this extension creates or updates a claim to be in that queue.

The url must be http://schemas.canvasmedical.com/fhir/extensions/claim-queue and the system must be http://canvasmedical.com

Supported claim queues

displaycode
AdjudicatedAdjudicatedOpenBalance
AppointmentAppointment
ClinicianNeedsClinicianReview
CodingNeedsCodingReview
FiledFiledAwaitingResponse
HistoryZeroBalance
PatientPatientBalance
RejectedRejectedNeedsReview
SubmissionQueuedForSubmission
TrashTrash
status
string

The status of the resource instance.

Supported codes for create interactions are: active

type
json

The category of claim.

Supported codes for create interactions are: professional with a system of http://terminology.hl7.org/CodeSystem/claim-type

use
string

A code to indicate the nature of the request

Supported codes for create interactions are: claim

patient
json

The Canvas patient resource for the claim

created
date

The date this resource was created.
Canvas will use this as the date of service for the claims in this message.

Expected format is : YYYY-MM-DD

provider
json

The Canvas provider resource for the staff responsible for the claim.

priority
json

The provider-required urgency of processing the request.

Supported codes for create interactions are: normal with a system of http://terminology.hl7.org/CodeSystem/processpriority

supportingInfo
array[json]

Additional information about the Claim

Canvas supports a single iteration for a reason for visit - the text in the valueString will be used.

diagnosis
array[json]

Information about diagnoses relevant to the claim items.

These diagnoses will create Assessments in Canvas.

The sequence should be unique within the Claim message, usually starting at 1 and incrementing as needed.

Must be a diagnosisCodeableConcept

Codes are supported from the following systems: http://hl7.org/fhir/sid/icd-10-cm

insurance
array[json]

FHIR resource for the coverage(s) to use when adjudicating the claim

sequence should be unique for each insurance in the claim message.

focal indicates whether this insurance should be used to adjudicate the claim in this message. Canvas will ignore any elements that are False.

coverage is a Canvas coverage resource identifying the coverage for this iteration of insurance

Additional information on a Coverage can be obtained from the Coverage search endpoint

item
array[json]

List of service charges to be used in the claim.

sequence should be unique for each item in the message.

diagnosisSequence should have one or more sequence values from the diagnosis section.

productOrService is an object that specifies the coding of the service. Canvas uses the first coding where system is http://www.ama-assn.org/go/cpt.

modifier specifies the list of charge modifier codings. Canvas accepts the first element where the coding’s system is https://www.cms.gov/Medicare/Coding/HCPCSReleaseCodeSets. Canvas uses the 2 character modifiers from this CodeSet.

Responses

200 OK
Request was successful.

Errors

400 Bad Request
The request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401 Unauthorized
The request requires user authentication.
403 Forbidden
The request requires user authorization.
  • 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"
          }
        }
      ]
    }