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

resourceType
string

The FHIR Resource name.

extension
array[json]

Canvas supports a single extension iteration on a claim to represent the current queue the given claim is in on the Canvas instance. Learn more about navigating claim queues here.

Canvas Claim Queues

displaycode
AdjudicatedAdjudicatedOpenBalance
AppointmentAppointment
ClinicianNeedsClinicianReview
CodingNeedsCodingReview
FiledFiledAwaitingResponse
HistoryZeroBalance
PatientPatientBalance
RejectedRejectedNeedsReview
SubmissionQueuedForSubmission
TrashTrash

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.

Click to view child attributes
url
string required

Reference that defines the content of this object.

Value Options Supported:
  • http://schemas.canvasmedical.com/fhir/extensions/claim-queue
valueCoding
json required

Value of extension.

Click to view child attributes
system
string required

The system url of the coding.

Value Options Supported:
  • http://canvasmedical.com
code
string required
Value Options Supported:
  • NeedsClinicianReview
  • NeedsCodingReview
  • QueuedForSubmission
  • FiledAwaitingResponse
  • RejectedNeedsReview
  • AdjudicatedOpenBalance
  • PatientBalance
  • ZeroBalance
  • Trash
  • Appointment
display
string

The display name of the coding.

Value Options Supported:
  • Adjudicated
  • Appointment
  • Clinician
  • Coding
  • Filed
  • History
  • Patient
  • Rejected
  • Submission
  • Trash
status
enum [ active ] required

The status of the resource instance.

type
json required

The category of claim.

Click to view child attributes
coding
array[json] required

Code defined by a terminology system.

Click to view child attributes
system
string required

The system url of the coding.

Value Options Supported:
  • http://terminology.hl7.org/CodeSystem/claim-type
  • http://hl7.org/fhir/ValueSet/claim-type
code
string required

The code.

Value Options Supported:
  • professional
display
string

The display name of the coding.

Value Options Supported:
  • Professional
use
enum [ claim ] required

A code to indicate the nature of the request.

patient
json required

The Canvas patient resource for the claim.

Click to view child attributes
reference
string required

The reference string of the subject in the format of "Patient/a39cafb9d1b445be95a2e2548e12a787".

type
string

Type the reference refers to (e.g. “Patient”).

created
datetime [ YYYY-MM-DDTHH:mm:ssZZ | YYYY-MM-DD ] required

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.

provider
json required

Party responsible for the claim. This will be a reference to a Practitioner.

Click to view child attributes
reference
string required

The reference string of the subject in the format of "Practitioner/bb24f084e1fa46c7931663259540266d".

type
string

Type the reference refers to (e.g. “Practitioner”).

priority
json required

The provider-required urgency of processing the request.

Click to view child attributes
coding
array[json] required

Code defined by a terminology system.

Click to view child attributes
system
string required

The system url of the coding.

Value Options Supported:
  • http://hl7.org/fhir/ValueSet/process-priority
  • http://terminology.hl7.org/CodeSystem/processpriority
code
string required

The code.

Value Options Supported:
  • normal
display
string

The display name of the coding.

Value Options Supported:
  • Normal
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 the note’s RFV the claim is associated with.

Click to view child attributes
sequence
positive integer required

Information instance identifier. Most likely will be 1 since Canvas currently only accepts one SupportingInfo object.

category
json required

Classification of the supplied information.

Click to view child attributes
system
string required

The system url of the coding.

Value Options Supported:
  • http://hl7.org/fhir/ValueSet/claim-informationcategory
  • http://terminology.hl7.org/CodeSystem/claiminformationcategory
code
string required

The code.

Value Options Supported:
  • patientreasonforvisit
display
string

The display name of the coding.

Value Options Supported:
  • Patient Reason for Visit
valueString
string

Data to be provided.

Canvas supports free text to be passed as the reason for visit associated with the claim.

diagnosis
array[json] required

Information about diagnoses relevant to the claim items.

These diagnoses will create Assessments in Canvas. At least one diagnosis element is required.

Click to view child attributes
sequence
positive integer required

Diagnosis instance identifier.

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

diagnosisCodeableConcept
array[json] required

Nature of illness or problem.

Click to view child attributes
system
string required

The system url of the coding.

Value Options Supported:
  • http://hl7.org/fhir/ValueSet/icd-10
  • http://hl7.org/fhir/sid/icd-10-cm
code
string required

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)

display
string

The display name of the coding.

insurance
array[json] required

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"
          }
      }
  ]
Click to view child attributes
focal
boolean required

Coverage to be used for adjudication.

Canvas will ignore any elements that are set to False.

sequence
positive integer required

Insurance instance identifier.

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

coverage
json required

Insurance Information

Click to view child attributes
reference
string

The reference string of the coverage in the format of "Coverage/05274c93-341c-4d23-9e46-718f6743609f".

display
string

A display of "No Coverage" are for claims that are self pay.

Value Options Supported:
  • No Coverage
item
array[json] required

List of service charges to be used in the claim.

Click to view child attributes
sequence
positive integer required

Item instance identifier.

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

diagnosisSequence
array[positive integer] required

Applicable diagnoses. This list of integers corresponds one or more diagnoses in the Claim.diagnosis list that this service charge is associated with.

productOrService
json required

Billing, service, product, or drug code.

Click to view child attributes
coding
array[json] required

Code defined by a terminology system.

Click to view child attributes
system
string required

The system url of the coding.

Value Options Supported:
  • http://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code
  • http://www.ama-assn.org/go/cpt
code
string required

The code.

display
string required

The display name of the coding.

quantity
json required

Count of products or services.

Click to view child attributes
value
integer

Numerical value.

unitPrice
json required

Fee, charge or cost per item.

Click to view child attributes
value
integer

Numerical value (with implicit precision)

modifier
array[json]

Product or service billing modifiers.

Click to view child attributes
coding
array[json] required

Code defined by a terminology system.

Click to view child attributes
system
string required

The system url of the coding.

Value Options Supported:
  • hhttp://hl7.org/fhir/us/carin-bb/ValueSet/AMACPTCMSHCPCSModifiers
  • https://www.cms.gov/Medicare/Coding/HCPCSReleaseCodeSets
code
string required

The code.

display
string required

The display name of the coding.

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

resourceType
string

The FHIR Resource name.

id
string

The identifier of the Claim.

extension
array[json]

Canvas supports a single extension iteration on a claim to represent the current queue the given claim is in on the Canvas instance. Learn more about navigating claim queues here.

Canvas Claim Queues

displaycode
AdjudicatedAdjudicatedOpenBalance
AppointmentAppointment
ClinicianNeedsClinicianReview
CodingNeedsCodingReview
FiledFiledAwaitingResponse
HistoryZeroBalance
PatientPatientBalance
RejectedRejectedNeedsReview
SubmissionQueuedForSubmission
TrashTrash
Click to view child attributes
url
string

Reference that defines the content of this object.

Value Options Supported:
  • http://schemas.canvasmedical.com/fhir/extensions/claim-queue
valueCoding
json

Value of extension.

Click to view child attributes
system
string

The system url of the coding.

Value Options Supported:
  • http://canvasmedical.com
code
string
Value Options Supported:
  • NeedsClinicianReview
  • NeedsCodingReview
  • QueuedForSubmission
  • FiledAwaitingResponse
  • RejectedNeedsReview
  • AdjudicatedOpenBalance
  • PatientBalance
  • ZeroBalance
  • Trash
  • Appointment
display
string

The display name of the coding.

Value Options Supported:
  • Adjudicated
  • Appointment
  • Clinician
  • Coding
  • Filed
  • History
  • Patient
  • Rejected
  • Submission
  • Trash
status
enum [ active ]

The status of the resource instance.

type
json

The category of claim.

Click to view child attributes
coding
array[json]

Code defined by a terminology system.

Click to view child attributes
system
string

The system url of the coding.

Value Options Supported:
  • http://terminology.hl7.org/CodeSystem/claim-type
  • http://hl7.org/fhir/ValueSet/claim-type
code
string

The code.

Value Options Supported:
  • professional
display
string

The display name of the coding.

Value Options Supported:
  • Professional
use
enum [ claim ]

A code to indicate the nature of the request.

patient
json

The Canvas patient resource for the claim.

Click to view child attributes
reference
string

The reference string of the subject in the format of "Patient/a39cafb9d1b445be95a2e2548e12a787".

type
string

Type the reference refers to (e.g. “Patient”).

created
datetime [ YYYY-MM-DDTHH:mm:ssZZ | YYYY-MM-DD ]

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.

provider
json

Party responsible for the claim. This will be a reference to a Practitioner.

Click to view child attributes
reference
string

The reference string of the subject in the format of "Practitioner/bb24f084e1fa46c7931663259540266d".

type
string

Type the reference refers to (e.g. “Practitioner”).

priority
json

The provider-required urgency of processing the request.

Click to view child attributes
coding
array[json]

Code defined by a terminology system.

Click to view child attributes
system
string

The system url of the coding.

Value Options Supported:
  • http://hl7.org/fhir/ValueSet/process-priority
  • http://terminology.hl7.org/CodeSystem/processpriority
code
string

The code.

Value Options Supported:
  • normal
display
string

The display name of the coding.

Value Options Supported:
  • Normal
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 the note’s RFV the claim is associated with.

Click to view child attributes
sequence
positive integer

Information instance identifier. Most likely will be 1 since Canvas currently only accepts one SupportingInfo object.

category
json

Classification of the supplied information.

Click to view child attributes
system
string

The system url of the coding.

Value Options Supported:
  • http://hl7.org/fhir/ValueSet/claim-informationcategory
  • http://terminology.hl7.org/CodeSystem/claiminformationcategory
code
string

The code.

Value Options Supported:
  • patientreasonforvisit
display
string

The display name of the coding.

Value Options Supported:
  • Patient Reason for Visit
valueString
string

Data to be provided.

Canvas supports free text to be passed as the reason for visit associated with the claim.

diagnosis
array[json]

Information about diagnoses relevant to the claim items.

Click to view child attributes
sequence
positive integer

Diagnosis instance identifier.

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

diagnosisCodeableConcept
array[json]

Nature of illness or problem.

Click to view child attributes
system
string

The system url of the coding.

Value Options Supported:
  • http://hl7.org/fhir/ValueSet/icd-10
  • http://hl7.org/fhir/sid/icd-10-cm
code
string

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)

display
string

The display name of the coding.

insurance
array[json]

Patient insurance information. Contains the list of coverage’s associated with the claim in Canvas.

Click to view child attributes
focal
boolean

Coverage to be used for adjudication.

Only insurance objects with focal as True will be returned in a Search/Read.

sequence
positive integer

Insurance instance identifier.

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

coverage
json

Insurance Information

Click to view child attributes
reference
string

The reference string of the coverage in the format of "Coverage/05274c93-341c-4d23-9e46-718f6743609f".

display
string

A display of "No Coverage" are for claims that are self pay.

Value Options Supported:
  • No Coverage
item
array[json]

List of service charges to be used in the claim.

Click to view child attributes
sequence
positive integer

Item instance identifier.

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

diagnosisSequence
array[positive integer]

Applicable diagnoses. This list of integers corresponds one or more diagnoses in the Claim.diagnosis list that this service charge is associated with.

productOrService
json

Billing, service, product, or drug code.

Click to view child attributes
coding
array[json]

Code defined by a terminology system.

Click to view child attributes
system
string

The system url of the coding.

Value Options Supported:
  • http://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code
  • http://www.ama-assn.org/go/cpt
code
string

The code.

display
string

The display name of the coding.

quantity
json

Count of products or services.

Click to view child attributes
value
integer

Numerical value.

unitPrice
json

Fee, charge or cost per item.

Click to view child attributes
value
integer

Numerical value (with implicit precision)

modifier
array[json]

Product or service billing modifiers.

Click to view child attributes
coding
array[json]

Code defined by a terminology system.

Click to view child attributes
system
string

The system url of the coding.

Value Options Supported:
  • hhttp://hl7.org/fhir/us/carin-bb/ValueSet/AMACPTCMSHCPCSModifiers
  • https://www.cms.gov/Medicare/Coding/HCPCSReleaseCodeSets
code
string

The code.

display
string

The display name of the coding.

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

resourceType
string

The FHIR Resource name.

id
string required

The identifier of the Claim.

extension
array[json]

Canvas supports a single extension iteration on a claim to represent the current queue the given claim is in on the Canvas instance. Learn more about navigating claim queues here.

Canvas Claim Queues

displaycode
AdjudicatedAdjudicatedOpenBalance
AppointmentAppointment
ClinicianNeedsClinicianReview
CodingNeedsCodingReview
FiledFiledAwaitingResponse
HistoryZeroBalance
PatientPatientBalance
RejectedRejectedNeedsReview
SubmissionQueuedForSubmission
TrashTrash

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.

Click to view child attributes
url
string required

Reference that defines the content of this object.

Value Options Supported:
  • http://schemas.canvasmedical.com/fhir/extensions/claim-queue
valueCoding
json required

Value of extension.

Click to view child attributes
system
string required

The system url of the coding.

Value Options Supported:
  • http://canvasmedical.com
code
string required
Value Options Supported:
  • NeedsClinicianReview
  • NeedsCodingReview
  • QueuedForSubmission
  • FiledAwaitingResponse
  • RejectedNeedsReview
  • AdjudicatedOpenBalance
  • PatientBalance
  • ZeroBalance
  • Trash
  • Appointment
display
string

The display name of the coding.

Value Options Supported:
  • Adjudicated
  • Appointment
  • Clinician
  • Coding
  • Filed
  • History
  • Patient
  • Rejected
  • Submission
  • Trash
status
enum [ active ] required

The status of the resource instance.

type
json required

The category of claim.

Click to view child attributes
coding
array[json] required

Code defined by a terminology system.

Click to view child attributes
system
string required

The system url of the coding.

Value Options Supported:
  • http://terminology.hl7.org/CodeSystem/claim-type
  • http://hl7.org/fhir/ValueSet/claim-type
code
string required

The code.

Value Options Supported:
  • professional
display
string

The display name of the coding.

Value Options Supported:
  • Professional
use
enum [ claim ] required

A code to indicate the nature of the request.

patient
json required

The Canvas patient resource for the claim.

Click to view child attributes
reference
string required

The reference string of the subject in the format of "Patient/a39cafb9d1b445be95a2e2548e12a787".

type
string

Type the reference refers to (e.g. “Patient”).

created
datetime [ YYYY-MM-DDTHH:mm:ssZZ | YYYY-MM-DD ] required

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.

provider
json required

Party responsible for the claim. This will be a reference to a Practitioner.

Click to view child attributes
reference
string required

The reference string of the subject in the format of "Practitioner/bb24f084e1fa46c7931663259540266d".

type
string

Type the reference refers to (e.g. “Practitioner”).

priority
json required

The provider-required urgency of processing the request.

Click to view child attributes
coding
array[json] required

Code defined by a terminology system.

Click to view child attributes
system
string required

The system url of the coding.

Value Options Supported:
  • http://hl7.org/fhir/ValueSet/process-priority
  • http://terminology.hl7.org/CodeSystem/processpriority
code
string required

The code.

Value Options Supported:
  • normal
display
string

The display name of the coding.

Value Options Supported:
  • Normal
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 the note’s RFV the claim is associated with.

Click to view child attributes
sequence
positive integer required

Information instance identifier. Most likely will be 1 since Canvas currently only accepts one SupportingInfo object.

category
json required

Classification of the supplied information.

Click to view child attributes
system
string required

The system url of the coding.

Value Options Supported:
  • http://hl7.org/fhir/ValueSet/claim-informationcategory
  • http://terminology.hl7.org/CodeSystem/claiminformationcategory
code
string required

The code.

Value Options Supported:
  • patientreasonforvisit
display
string

The display name of the coding.

Value Options Supported:
  • Patient Reason for Visit
valueString
string

Data to be provided.

Canvas supports free text to be passed as the reason for visit associated with the claim.

diagnosis
array[json] required

Information about diagnoses relevant to the claim items.

These diagnoses will create Assessments in Canvas. At least one diagnosis element is required.

Click to view child attributes
sequence
positive integer required

Diagnosis instance identifier.

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

diagnosisCodeableConcept
array[json] required

Nature of illness or problem.

Click to view child attributes
system
string required

The system url of the coding.

Value Options Supported:
  • http://hl7.org/fhir/ValueSet/icd-10
  • http://hl7.org/fhir/sid/icd-10-cm
code
string required

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)

display
string

The display name of the coding.

insurance
array[json] required

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"
          }
      }
  ]
Click to view child attributes
focal
boolean required

Coverage to be used for adjudication.

Canvas will ignore any elements that are set to False.

sequence
positive integer required

Insurance instance identifier.

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

coverage
json required

Insurance Information

Click to view child attributes
reference
string

The reference string of the coverage in the format of "Coverage/05274c93-341c-4d23-9e46-718f6743609f".

display
string

A display of "No Coverage" are for claims that are self pay.

Value Options Supported:
  • No Coverage
item
array[json] required

List of service charges to be used in the claim.

Click to view child attributes
sequence
positive integer required

Item instance identifier.

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

diagnosisSequence
array[positive integer] required

Applicable diagnoses. This list of integers corresponds one or more diagnoses in the Claim.diagnosis list that this service charge is associated with.

productOrService
json required

Billing, service, product, or drug code.

Click to view child attributes
coding
array[json] required

Code defined by a terminology system.

Click to view child attributes
system
string required

The system url of the coding.

Value Options Supported:
  • http://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code
  • http://www.ama-assn.org/go/cpt
code
string required

The code.

display
string required

The display name of the coding.

quantity
json required

Count of products or services.

Click to view child attributes
value
integer

Numerical value.

unitPrice
json required

Fee, charge or cost per item.

Click to view child attributes
value
integer

Numerical value (with implicit precision)

modifier
array[json]

Product or service billing modifiers.

Click to view child attributes
coding
array[json] required

Code defined by a terminology system.

Click to view child attributes
system
string required

The system url of the coding.

Value Options Supported:
  • hhttp://hl7.org/fhir/us/carin-bb/ValueSet/AMACPTCMSHCPCSModifiers
  • https://www.cms.gov/Medicare/Coding/HCPCSReleaseCodeSets
code
string required

The code.

display
string required

The display name of the coding.

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

The patient reference associated to the Claim in the format Patient/a39cafb9d1b445be95a2e2548e12a787.

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

resourceType
string

The FHIR Resource name.

id
string

The identifier of the Claim.

extension
array[json]

Canvas supports a single extension iteration on a claim to represent the current queue the given claim is in on the Canvas instance. Learn more about navigating claim queues here.

Canvas Claim Queues

displaycode
AdjudicatedAdjudicatedOpenBalance
AppointmentAppointment
ClinicianNeedsClinicianReview
CodingNeedsCodingReview
FiledFiledAwaitingResponse
HistoryZeroBalance
PatientPatientBalance
RejectedRejectedNeedsReview
SubmissionQueuedForSubmission
TrashTrash
Click to view child attributes
url
string

Reference that defines the content of this object.

Value Options Supported:
  • http://schemas.canvasmedical.com/fhir/extensions/claim-queue
valueCoding
json

Value of extension.

Click to view child attributes
system
string

The system url of the coding.

Value Options Supported:
  • http://canvasmedical.com
code
string
Value Options Supported:
  • NeedsClinicianReview
  • NeedsCodingReview
  • QueuedForSubmission
  • FiledAwaitingResponse
  • RejectedNeedsReview
  • AdjudicatedOpenBalance
  • PatientBalance
  • ZeroBalance
  • Trash
  • Appointment
display
string

The display name of the coding.

Value Options Supported:
  • Adjudicated
  • Appointment
  • Clinician
  • Coding
  • Filed
  • History
  • Patient
  • Rejected
  • Submission
  • Trash
status
enum [ active ]

The status of the resource instance.

type
json

The category of claim.

Click to view child attributes
coding
array[json]

Code defined by a terminology system.

Click to view child attributes
system
string

The system url of the coding.

Value Options Supported:
  • http://terminology.hl7.org/CodeSystem/claim-type
  • http://hl7.org/fhir/ValueSet/claim-type
code
string

The code.

Value Options Supported:
  • professional
display
string

The display name of the coding.

Value Options Supported:
  • Professional
use
enum [ claim ]

A code to indicate the nature of the request.

patient
json

The Canvas patient resource for the claim.

Click to view child attributes
reference
string

The reference string of the subject in the format of "Patient/a39cafb9d1b445be95a2e2548e12a787".

type
string

Type the reference refers to (e.g. “Patient”).

created
datetime [ YYYY-MM-DDTHH:mm:ssZZ | YYYY-MM-DD ]

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.

provider
json

Party responsible for the claim. This will be a reference to a Practitioner.

Click to view child attributes
reference
string

The reference string of the subject in the format of "Practitioner/bb24f084e1fa46c7931663259540266d".

type
string

Type the reference refers to (e.g. “Practitioner”).

priority
json

The provider-required urgency of processing the request.

Click to view child attributes
coding
array[json]

Code defined by a terminology system.

Click to view child attributes
system
string

The system url of the coding.

Value Options Supported:
  • http://hl7.org/fhir/ValueSet/process-priority
  • http://terminology.hl7.org/CodeSystem/processpriority
code
string

The code.

Value Options Supported:
  • normal
display
string

The display name of the coding.

Value Options Supported:
  • Normal
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 the note’s RFV the claim is associated with.

Click to view child attributes
sequence
positive integer

Information instance identifier. Most likely will be 1 since Canvas currently only accepts one SupportingInfo object.

category
json

Classification of the supplied information.

Click to view child attributes
system
string

The system url of the coding.

Value Options Supported:
  • http://hl7.org/fhir/ValueSet/claim-informationcategory
  • http://terminology.hl7.org/CodeSystem/claiminformationcategory
code
string

The code.

Value Options Supported:
  • patientreasonforvisit
display
string

The display name of the coding.

Value Options Supported:
  • Patient Reason for Visit
valueString
string

Data to be provided.

Canvas supports free text to be passed as the reason for visit associated with the claim.

diagnosis
array[json]

Information about diagnoses relevant to the claim items.

Click to view child attributes
sequence
positive integer

Diagnosis instance identifier.

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

diagnosisCodeableConcept
array[json]

Nature of illness or problem.

Click to view child attributes
system
string

The system url of the coding.

Value Options Supported:
  • http://hl7.org/fhir/ValueSet/icd-10
  • http://hl7.org/fhir/sid/icd-10-cm
code
string

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)

display
string

The display name of the coding.

insurance
array[json]

Patient insurance information. Contains the list of coverage’s associated with the claim in Canvas.

Click to view child attributes
focal
boolean

Coverage to be used for adjudication.

Only insurance objects with focal as True will be returned in a Search/Read.

sequence
positive integer

Insurance instance identifier.

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

coverage
json

Insurance Information

Click to view child attributes
reference
string

The reference string of the coverage in the format of "Coverage/05274c93-341c-4d23-9e46-718f6743609f".

display
string

A display of "No Coverage" are for claims that are self pay.

Value Options Supported:
  • No Coverage
item
array[json]

List of service charges to be used in the claim.

Click to view child attributes
sequence
positive integer

Item instance identifier.

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

diagnosisSequence
array[positive integer]

Applicable diagnoses. This list of integers corresponds one or more diagnoses in the Claim.diagnosis list that this service charge is associated with.

productOrService
json

Billing, service, product, or drug code.

Click to view child attributes
coding
array[json]

Code defined by a terminology system.

Click to view child attributes
system
string

The system url of the coding.

Value Options Supported:
  • http://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code
  • http://www.ama-assn.org/go/cpt
code
string

The code.

display
string

The display name of the coding.

quantity
json

Count of products or services.

Click to view child attributes
value
integer

Numerical value.

unitPrice
json

Fee, charge or cost per item.

Click to view child attributes
value
integer

Numerical value (with implicit precision)

modifier
array[json]

Product or service billing modifiers.

Click to view child attributes
coding
array[json]

Code defined by a terminology system.

Click to view child attributes
system
string

The system url of the coding.

Value Options Supported:
  • hhttp://hl7.org/fhir/us/carin-bb/ValueSet/AMACPTCMSHCPCSModifiers
  • https://www.cms.gov/Medicare/Coding/HCPCSReleaseCodeSets
code
string

The code.

display
string

The display name of the coding.

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"
          }
        }
      ]
    }